diff --git a/Cargo.lock b/Cargo.lock index 9fcfa8f..c0b11c4 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -1,6 +1,6 @@ # This file is automatically @generated by Cargo. # It is not intended for manual editing. -version = 3 +version = 4 [[package]] name = "adler2" @@ -98,9 +98,9 @@ dependencies = [ [[package]] name = "cbindgen" -version = "0.27.0" +version = "0.28.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "3fce8dd7fcfcbf3a0a87d8f515194b49d6135acab73e18bd380d1d93bb1a15eb" +checksum = "eadd868a2ce9ca38de7eeafdcec9c7065ef89b42b32f0839278d55f35c54d1ff" dependencies = [ "clap", "heck", @@ -407,9 +407,8 @@ dependencies = [ [[package]] name = "servicepoint" -version = "0.13.1" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "93b52049be55a15fe37c13249d7f96aa8a5de56e1a41838e74a822ee8316a0c4" +version = "0.13.2" +source = "git+https://git.berlin.ccc.de/servicepoint/servicepoint/?branch=next#971bee5065139f220022e8108cfaa9c263b8a8a0" dependencies = [ "bitvec", "bzip2", diff --git a/Cargo.toml b/Cargo.toml index 7750abc..7e5ed5d 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -15,14 +15,31 @@ keywords = ["cccb", "cccb-servicepoint", "cbindgen"] crate-type = ["staticlib", "cdylib", "rlib"] [build-dependencies] -cbindgen = "0.27.0" +cbindgen = "0.28.0" [dependencies.servicepoint] -version = "0.13.1" -features = ["all_compressions"] +package = "servicepoint" +version = "0.13.2" +default-features = false +features = ["protocol_udp"] +git = "https://git.berlin.ccc.de/servicepoint/servicepoint/" +branch = "next" + +[features] +full = ["servicepoint/all_compressions", "servicepoint/default"] +default = ["full"] [lints.rust] missing-docs = "warn" +unsafe_op_in_unsafe_fn = "warn" [package.metadata.docs.rs] all-features = true + +[profile.size-optimized] +inherits = "release" +opt-level = 'z' # Optimize for size +lto = true # Enable link-time optimization +codegen-units = 1 # Reduce number of codegen units to increase optimizations +panic = 'abort' # Abort on panic +strip = true # Strip symbols from binary diff --git a/build.rs b/build.rs index 93bf703..83e9641 100644 --- a/build.rs +++ b/build.rs @@ -6,28 +6,30 @@ use std::{env, fs::copy}; -use cbindgen::{generate_with_config, Config}; - fn main() { let crate_dir = env::var("CARGO_MANIFEST_DIR").unwrap(); println!("cargo::rerun-if-changed={crate_dir}"); let config = - Config::from_file(crate_dir.clone() + "/cbindgen.toml").unwrap(); + cbindgen::Config::from_file(crate_dir.clone() + "/cbindgen.toml") + .unwrap(); let output_dir = env::var("OUT_DIR").unwrap(); let header_file = output_dir.clone() + "/servicepoint.h"; - generate_with_config(crate_dir, config) - .unwrap() - .write_to_file(&header_file); - println!("cargo:include={output_dir}"); + if let Ok(bindings) = cbindgen::generate_with_config(crate_dir, config) { + bindings.write_to_file(&header_file); - println!("cargo::rerun-if-env-changed=SERVICEPOINT_HEADER_OUT"); - if let Ok(header_out) = env::var("SERVICEPOINT_HEADER_OUT") { - let header_copy = header_out + "/servicepoint.h"; - println!("cargo:warning=Copying header to {header_copy}"); - copy(header_file, &header_copy).unwrap(); - println!("cargo::rerun-if-changed={header_copy}"); + println!("cargo:include={output_dir}"); + + println!("cargo::rerun-if-env-changed=SERVICEPOINT_HEADER_OUT"); + if let Ok(header_out) = env::var("SERVICEPOINT_HEADER_OUT") { + let header_copy = header_out + "/servicepoint.h"; + println!("cargo:warning=Copying header to {header_copy}"); + copy(header_file, &header_copy).unwrap(); + println!("cargo::rerun-if-changed={header_copy}"); + } + } else { + eprintln!("cargo:warning=Servicepoint header could not be generated"); } } diff --git a/cbindgen.toml b/cbindgen.toml index 7fc0fdf..48ef574 100644 --- a/cbindgen.toml +++ b/cbindgen.toml @@ -19,18 +19,26 @@ line_endings = "LF" style = "type" usize_is_size_t = true -# this is needed because otherwise the order in the C# bindings is different on different machines +# this is needed because otherwise the order in the C bindings is different on different machines sort_by = "Name" [parse] -parse_deps = false +parse_deps = true +include = ["servicepoint"] +extra_bindings = ["servicepoint"] [parse.expand] -all_features = true +features = ["full"] [export] include = [] exclude = [] +[export.rename] +"TypedCommand" = "Command" + [enum] rename_variants = "QualifiedScreamingSnakeCase" + +[ptr] +non_null_attribute = "/*notnull*/" diff --git a/examples/lang_c/Makefile b/examples/lang_c/Makefile index 6b15722..aa31733 100644 --- a/examples/lang_c/Makefile +++ b/examples/lang_c/Makefile @@ -1,7 +1,47 @@ CC := gcc +CARGO := rustup run nightly cargo THIS_DIR := $(dir $(realpath $(lastword $(MAKEFILE_LIST)))) -REPO_ROOT := $(THIS_DIR)/../../../.. +REPO_ROOT := $(THIS_DIR)/../../ +RUST_TARGET_DIR := $(REPO_ROOT)/target/x86_64-unknown-linux-musl/size-optimized + +RUSTFLAGS := -Zlocation-detail=none \ + -Zfmt-debug=none \ + -C linker=musl-gcc \ + -C link-arg=-s \ + -C link-arg=--gc-sections \ + -C link-arg=-z,norelro \ + -C link-arg=--hash-style=gnu \ + --crate-type=staticlib \ + -C panic=abort + +CARGOFLAGS := --manifest-path=$(REPO_ROOT)/Cargo.toml \ + --profile=size-optimized \ + --no-default-features \ + --target=x86_64-unknown-linux-musl \ + -Zbuild-std="core,std,alloc,proc_macro,panic_abort" \ + -Zbuild-std-features="panic_immediate_abort" \ + +CCFLAGS := -static -Os \ + -ffunction-sections -fdata-sections \ + -fwrapv -fomit-frame-pointer -fno-stack-protector\ + -fwhole-program \ + -nodefaultlibs -lservicepoint_binding_c -lc \ + -Wl,--gc-sections \ + -fno-unroll-loops \ + -fno-unwind-tables -fno-asynchronous-unwind-tables \ + -fmerge-all-constants \ + -Wl,-z,norelro \ + -Wl,--hash-style=gnu \ + -fvisibility=hidden \ + -Bsymbolic \ + -Wl,--exclude-libs,ALL \ + -fno-ident + #-fuse-ld=gold \ + -fno-exceptions + #-Wl,--icf=all \ + +export SERVICEPOINT_HEADER_OUT := $(THIS_DIR)/include build: out/lang_c @@ -15,20 +55,19 @@ run: out/lang_c PHONY: build clean dependencies run -out/lang_c: dependencies src/main.c +out/lang_c_unstripped: dependencies src/main.c mkdir -p out || true ${CC} src/main.c \ - -I include \ - -L $(REPO_ROOT)/target/release \ - -Wl,-Bstatic -lservicepoint_binding_c \ - -Wl,-Bdynamic -llzma \ - -o out/lang_c + -I $(SERVICEPOINT_HEADER_OUT) \ + -L $(RUST_TARGET_DIR)\ + $(CCFLAGS) \ + -o out/lang_c_unstripped +out/lang_c: out/lang_c_unstripped + strip -s -R .comment -R .gnu.version --strip-unneeded out/lang_c_unstripped -o out/lang_c +#strip -S --strip-unneeded --remove-section=.note.gnu.gold-version --remove-section=.comment --remove-section=.note --remove-section=.note.gnu.build-id --remove-section=.note.ABI-tag dependencies: FORCE mkdir -p include || true # generate servicepoint header and binary to link against - SERVICEPOINT_HEADER_OUT=$(THIS_DIR)/include cargo build \ - --manifest-path=$(REPO_ROOT)/crates/servicepoint_binding_c/Cargo.toml \ - --release - + ${CARGO} rustc $(CARGOFLAGS) -- $(RUSTFLAGS) FORCE: ; diff --git a/examples/lang_c/include/servicepoint.h b/examples/lang_c/include/servicepoint.h index d9cbe57..4a0af95 100644 --- a/examples/lang_c/include/servicepoint.h +++ b/examples/lang_c/include/servicepoint.h @@ -1,4 +1,4 @@ -/* Generated with cbindgen:0.27.0 */ +/* Generated with cbindgen:0.28.0 */ /* Warning, this file is autogenerated by cbindgen. Don't modify this manually. */ @@ -8,6 +8,35 @@ #include #include +/** + * pixel count on whole screen + */ +#define PIXEL_COUNT (PIXEL_WIDTH * PIXEL_HEIGHT) + +/** + * Display height in pixels + * + * # Examples + * + * ```rust + * # use servicepoint::{PIXEL_HEIGHT, PIXEL_WIDTH, Bitmap}; + * let grid = Bitmap::new(PIXEL_WIDTH, PIXEL_HEIGHT); + * ``` + */ +#define PIXEL_HEIGHT (TILE_HEIGHT * TILE_SIZE) + +/** + * Display width in pixels + * + * # Examples + * + * ```rust + * # use servicepoint::{PIXEL_HEIGHT, PIXEL_WIDTH, Bitmap}; + * let grid = Bitmap::new(PIXEL_WIDTH, PIXEL_HEIGHT); + * ``` + */ +#define PIXEL_WIDTH (TILE_WIDTH * TILE_SIZE) + /** * Count of possible brightness values */ @@ -23,40 +52,60 @@ */ #define SP_BRIGHTNESS_MIN 0 -/** - * pixel count on whole screen - */ -#define SP_PIXEL_COUNT (SP_PIXEL_WIDTH * SP_PIXEL_HEIGHT) - -/** - * Display height in pixels - */ -#define SP_PIXEL_HEIGHT (SP_TILE_HEIGHT * SP_TILE_SIZE) - -/** - * Display width in pixels - */ -#define SP_PIXEL_WIDTH (SP_TILE_WIDTH * SP_TILE_SIZE) - /** * Display tile count in the y-direction + * + * # Examples + * + * ```rust + * # use servicepoint::{Cp437Grid, TILE_HEIGHT, TILE_WIDTH}; + * let grid = Cp437Grid::new(TILE_WIDTH, TILE_HEIGHT); + * ``` */ -#define SP_TILE_HEIGHT 20 +#define TILE_HEIGHT 20 /** * size of a single tile in one dimension */ -#define SP_TILE_SIZE 8 +#define TILE_SIZE 8 /** * Display tile count in the x-direction + * + * # Examples + * + * ```rust + * # use servicepoint::{Cp437Grid, TILE_HEIGHT, TILE_WIDTH}; + * let grid = Cp437Grid::new(TILE_WIDTH, TILE_HEIGHT); + * ``` */ -#define SP_TILE_WIDTH 56 +#define TILE_WIDTH 56 /** - * Specifies the kind of compression to use. + * Specifies the kind of compression to use. Availability depends on features. + * + * # Examples + * + * ```rust + * # use servicepoint::*; + * // create command without payload compression + * # let pixels = Bitmap::max_sized(); + * _ = BitmapCommand { + * origin: Origin::ZERO, + * bitmap: pixels, + * compression: CompressionCode::Uncompressed + * }; + * + * // create command with payload compressed with lzma and appropriate header flags + * # let pixels = Bitmap::max_sized(); + * _ = BitmapCommand { + * origin: Origin::ZERO, + * bitmap: pixels, + * compression: CompressionCode::Lzma + * }; + * ``` */ -enum SPCompressionCode +enum CompressionCode #ifdef __cplusplus : uint16_t #endif // __cplusplus @@ -64,28 +113,54 @@ enum SPCompressionCode /** * no compression */ - SP_COMPRESSION_CODE_UNCOMPRESSED = 0, + COMPRESSION_CODE_UNCOMPRESSED = 0, /** * compress using flate2 with zlib header */ - SP_COMPRESSION_CODE_ZLIB = 26490, + COMPRESSION_CODE_ZLIB = 26490, /** * compress using bzip2 */ - SP_COMPRESSION_CODE_BZIP2 = 25210, + COMPRESSION_CODE_BZIP2 = 25210, /** * compress using lzma */ - SP_COMPRESSION_CODE_LZMA = 27770, + COMPRESSION_CODE_LZMA = 27770, /** * compress using Zstandard */ - SP_COMPRESSION_CODE_ZSTD = 31347, + COMPRESSION_CODE_ZSTD = 31347, }; #ifndef __cplusplus -typedef uint16_t SPCompressionCode; +typedef uint16_t CompressionCode; #endif // __cplusplus +/** + * A fixed-size 2D grid of booleans. + * + * The values are stored in packed bytes (8 values per byte) in the same order as used by the display for storing pixels. + * This means that no conversion is necessary for sending the data to the display. + * The downside is that the width has to be a multiple of 8. + * + * # Examples + * + * ```rust + * use servicepoint::Bitmap; + * let mut bitmap = Bitmap::new(8, 2); + * + * ``` + */ +typedef struct Bitmap Bitmap; + +/** + * The raw packet. + * + * Contents should probably only be used directly to use features not exposed by the library. + * + * You may want to use [`crate::Command`] or [`crate::TypedCommand`] instead. + */ +typedef struct Packet Packet; + /** * A vector of bits * @@ -99,108 +174,51 @@ typedef uint16_t SPCompressionCode; typedef struct SPBitVec SPBitVec; /** - * A grid of pixels. + * This enum contains all commands provided by the library. + * This is useful in case you want one data type for all kinds of commands without using `dyn`. * - * # Examples - * - * ```C - * Cp437Grid grid = sp_bitmap_new(8, 3); - * sp_bitmap_fill(grid, true); - * sp_bitmap_set(grid, 0, 0, false); - * sp_bitmap_free(grid); - * ``` + * Please look at the contained structs for documentation per command. */ -typedef struct SPBitmap SPBitmap; +typedef struct Command Command; /** - * A grid containing brightness values. + * A connection using the UDP protocol. * - * # Examples - * ```C - * SPConnection connection = sp_connection_open("127.0.0.1:2342"); - * if (connection == NULL) - * return 1; + * Use this when sending commands directly to the display. * - * SPBrightnessGrid grid = sp_brightness_grid_new(2, 2); - * sp_brightness_grid_set(grid, 0, 0, 0); - * sp_brightness_grid_set(grid, 1, 1, 10); - * - * SPCommand command = sp_command_char_brightness(grid); - * sp_connection_free(connection); - * ``` + * Requires the feature "`protocol_udp`" which is enabled by default. */ -typedef struct SPBrightnessGrid SPBrightnessGrid; +typedef struct UdpConnection UdpConnection; /** - * A C-wrapper for grid containing UTF-8 characters. + * A 2D grid of values. * - * As the rust [char] type is not FFI-safe, characters are passed in their UTF-32 form as 32bit unsigned integers. + * The memory layout is the one the display expects in [`crate::Command`]s. * - * The encoding is enforced in most cases by the rust standard library - * and will panic when provided with illegal characters. - * - * # Examples - * - * ```C - * CharGrid grid = sp_char_grid_new(4, 3); - * sp_char_grid_fill(grid, '?'); - * sp_char_grid_set(grid, 0, 0, '!'); - * sp_char_grid_free(grid); - * ``` + * This structure can be used with any type that implements the [Value] trait. + * You can also use the concrete type aliases provided in this crate, e.g. [`crate::CharGrid`] and [`crate::ByteGrid`]. */ -typedef struct SPCharGrid SPCharGrid; +typedef struct ValueGrid_Brightness ValueGrid_Brightness; /** - * A low-level display command. + * A 2D grid of values. * - * This struct and associated functions implement the UDP protocol for the display. + * The memory layout is the one the display expects in [`crate::Command`]s. * - * To send a [SPCommand], use a [SPConnection]. - * - * # Examples - * - * ```C - * sp_connection_send_command(connection, sp_command_clear()); - * sp_connection_send_command(connection, sp_command_brightness(5)); - * ``` - * - * [SPConnection]: [crate::SPConnection] + * This structure can be used with any type that implements the [Value] trait. + * You can also use the concrete type aliases provided in this crate, e.g. [`crate::CharGrid`] and [`crate::ByteGrid`]. */ -typedef struct SPCommand SPCommand; +typedef struct ValueGrid_char ValueGrid_char; /** - * A connection to the display. + * A 2D grid of values. * - * # Examples + * The memory layout is the one the display expects in [`crate::Command`]s. * - * ```C - * CConnection connection = sp_connection_open("172.23.42.29:2342"); - * if (connection != NULL) - * sp_connection_send_command(connection, sp_command_clear()); - * ``` + * This structure can be used with any type that implements the [Value] trait. + * You can also use the concrete type aliases provided in this crate, e.g. [`crate::CharGrid`] and [`crate::ByteGrid`]. */ -typedef struct SPConnection SPConnection; - -/** - * A C-wrapper for grid containing codepage 437 characters. - * - * The encoding is currently not enforced. - * - * # Examples - * - * ```C - * Cp437Grid grid = sp_cp437_grid_new(4, 3); - * sp_cp437_grid_fill(grid, '?'); - * sp_cp437_grid_set(grid, 0, 0, '!'); - * sp_cp437_grid_free(grid); - * ``` - */ -typedef struct SPCp437Grid SPCp437Grid; - -/** - * The raw packet - */ -typedef struct SPPacket SPPacket; +typedef struct ValueGrid_u8 ValueGrid_u8; /** * Represents a span of memory (`&mut [u8]` ) as a struct usable by C code. @@ -221,13 +239,96 @@ typedef struct { /** * The start address of the memory */ - uint8_t *start; + uint8_t */*notnull*/ start; /** * The amount of memory in bytes */ size_t length; } SPByteSlice; +/** + * A grid containing brightness values. + * + * # Examples + * + * ```rust + * # use servicepoint::*; + * let mut grid = BrightnessGrid::new(2,2); + * grid.set(0, 0, Brightness::MIN); + * grid.set(1, 1, Brightness::MIN); + * + * # let connection = FakeConnection; + * connection.send(BrightnessGridCommand { + * origin: Origin::new(3, 7), + * grid + * }).unwrap() + * ``` + */ +typedef ValueGrid_Brightness BrightnessGrid; + +/** + * A grid containing UTF-8 characters. + * + * To send a `CharGrid` to the display, use a [`crate::CharGridCommand`]. + * + * Also see [`ValueGrid`] for the non-specialized operations and examples. + * + * # Examples + * + * ```rust + * # use servicepoint::*; + * let grid = CharGrid::from("You can\nload multiline\nstrings directly"); + * assert_eq!(grid.get_row_str(1), Some("load multiline\0\0".to_string())); + * + * # let connection = FakeConnection; + * let command = CharGridCommand { origin: Origin::ZERO, grid }; + * connection.send(command).unwrap() + * ``` + */ +typedef ValueGrid_char CharGrid; + +/** + * A grid containing codepage 437 characters. + * + * The encoding is currently not enforced. + */ +typedef ValueGrid_u8 Cp437Grid; + +/** + * A raw header. + * + * The header specifies the kind of command, the size of the payload and where to display the + * payload, where applicable. + * + * Because the meaning of most fields depend on the command, there are no speaking names for them. + * + * The contained values are in platform endian-ness and may need to be converted before sending. + */ +typedef struct { + /** + * The first two bytes specify which command this packet represents. + */ + uint16_t command_code; + /** + * First command-specific value + */ + uint16_t a; + /** + * Second command-specific value + */ + uint16_t b; + /** + * Third command-specific value + */ + uint16_t c; + /** + * Fourth command-specific value + */ + uint16_t d; +} Header; + + + #ifdef __cplusplus extern "C" { #endif // __cplusplus @@ -250,7 +351,7 @@ extern "C" { * - the returned instance is freed in some way, either by using a consuming function or * by explicitly calling `sp_bitmap_free`. */ -SPBitmap *sp_bitmap_clone(const SPBitmap *bitmap); +Bitmap */*notnull*/ sp_bitmap_clone(Bitmap */*notnull*/ bitmap); /** * Sets the state of all pixels in the [SPBitmap]. @@ -271,7 +372,7 @@ SPBitmap *sp_bitmap_clone(const SPBitmap *bitmap); * - `bitmap` points to a valid [SPBitmap] * - `bitmap` is not written to or read from concurrently */ -void sp_bitmap_fill(SPBitmap *bitmap, bool value); +void sp_bitmap_fill(Bitmap */*notnull*/ bitmap, bool value); /** * Deallocates a [SPBitmap]. @@ -285,12 +386,10 @@ void sp_bitmap_fill(SPBitmap *bitmap, bool value); * The caller has to make sure that: * * - `bitmap` points to a valid [SPBitmap] - * - `bitmap` is not used concurrently or after bitmap call - * - `bitmap` was not passed to another consuming function, e.g. to create a [SPCommand] * * [SPCommand]: [crate::SPCommand] */ -void sp_bitmap_free(SPBitmap *bitmap); +void sp_bitmap_free(Bitmap */*notnull*/ bitmap); /** * Gets the current value at the specified position in the [SPBitmap]. @@ -312,7 +411,7 @@ void sp_bitmap_free(SPBitmap *bitmap); * - `bitmap` points to a valid [SPBitmap] * - `bitmap` is not written to concurrently */ -bool sp_bitmap_get(const SPBitmap *bitmap, size_t x, size_t y); +bool sp_bitmap_get(Bitmap */*notnull*/ bitmap, size_t x, size_t y); /** * Gets the height in pixels of the [SPBitmap] instance. @@ -331,7 +430,7 @@ bool sp_bitmap_get(const SPBitmap *bitmap, size_t x, size_t y); * * - `bitmap` points to a valid [SPBitmap] */ -size_t sp_bitmap_height(const SPBitmap *bitmap); +size_t sp_bitmap_height(Bitmap */*notnull*/ bitmap); /** * Loads a [SPBitmap] with the specified dimensions from the provided data. @@ -341,13 +440,18 @@ size_t sp_bitmap_height(const SPBitmap *bitmap); * - `width`: size in pixels in x-direction * - `height`: size in pixels in y-direction * - * returns: [SPBitmap] that contains a copy of the provided data. Will never return NULL. + * returns: [SPBitmap] that contains a copy of the provided data, or NULL in case of an error. + * + * # Errors + * + * In the following cases, this function will return NULL: + * + * - when the dimensions and data size do not match exactly. + * - when the width is not dividable by 8 * * # Panics * * - when `data` is NULL - * - when the dimensions and data size do not match exactly. - * - when the width is not dividable by 8 * * # Safety * @@ -357,10 +461,9 @@ size_t sp_bitmap_height(const SPBitmap *bitmap); * - the returned instance is freed in some way, either by using a consuming function or * by explicitly calling `sp_bitmap_free`. */ -SPBitmap *sp_bitmap_load(size_t width, - size_t height, - const uint8_t *data, - size_t data_length); +Bitmap *sp_bitmap_load(size_t width, + size_t height, + SPByteSlice data); /** * Creates a new [SPBitmap] with the specified dimensions. @@ -370,9 +473,11 @@ SPBitmap *sp_bitmap_load(size_t width, * - `width`: size in pixels in x-direction * - `height`: size in pixels in y-direction * - * returns: [SPBitmap] initialized to all pixels off. Will never return NULL. + * returns: [SPBitmap] initialized to all pixels off, or NULL in case of an error. * - * # Panics + * # Errors + * + * In the following cases, this function will return NULL: * * - when the width is not dividable by 8 * @@ -383,8 +488,8 @@ SPBitmap *sp_bitmap_load(size_t width, * - the returned instance is freed in some way, either by using a consuming function or * by explicitly calling `sp_bitmap_free`. */ -SPBitmap *sp_bitmap_new(size_t width, - size_t height); +Bitmap *sp_bitmap_new(size_t width, + size_t height); /** * Creates a new [SPBitmap] with a size matching the screen. @@ -398,7 +503,7 @@ SPBitmap *sp_bitmap_new(size_t width, * - the returned instance is freed in some way, either by using a consuming function or * by explicitly calling [sp_bitmap_free]. */ -SPBitmap *sp_bitmap_new_screen_sized(void); +Bitmap */*notnull*/ sp_bitmap_new_screen_sized(void); /** * Sets the value of the specified position in the [SPBitmap]. @@ -423,7 +528,7 @@ SPBitmap *sp_bitmap_new_screen_sized(void); * - `bitmap` points to a valid [SPBitmap] * - `bitmap` is not written to or read from concurrently */ -void sp_bitmap_set(SPBitmap *bitmap, size_t x, size_t y, bool value); +void sp_bitmap_set(Bitmap */*notnull*/ bitmap, size_t x, size_t y, bool value); /** * Gets an unsafe reference to the data of the [SPBitmap] instance. @@ -440,7 +545,7 @@ void sp_bitmap_set(SPBitmap *bitmap, size_t x, size_t y, bool value); * - the returned memory range is never accessed after the passed [SPBitmap] has been freed * - the returned memory range is never accessed concurrently, either via the [SPBitmap] or directly */ -SPByteSlice sp_bitmap_unsafe_data_ref(SPBitmap *bitmap); +SPByteSlice sp_bitmap_unsafe_data_ref(Bitmap */*notnull*/ bitmap); /** * Gets the width in pixels of the [SPBitmap] instance. @@ -459,7 +564,7 @@ SPByteSlice sp_bitmap_unsafe_data_ref(SPBitmap *bitmap); * * - `bitmap` points to a valid [SPBitmap] */ -size_t sp_bitmap_width(const SPBitmap *bitmap); +size_t sp_bitmap_width(Bitmap */*notnull*/ bitmap); /** * Clones a [SPBitVec]. @@ -479,7 +584,7 @@ size_t sp_bitmap_width(const SPBitmap *bitmap); * - the returned instance is freed in some way, either by using a consuming function or * by explicitly calling `sp_bitvec_free`. */ -SPBitVec *sp_bitvec_clone(const SPBitVec *bit_vec); +SPBitVec */*notnull*/ sp_bitvec_clone(SPBitVec */*notnull*/ bit_vec); /** * Sets the value of all bits in the [SPBitVec]. @@ -500,7 +605,7 @@ SPBitVec *sp_bitvec_clone(const SPBitVec *bit_vec); * - `bit_vec` points to a valid [SPBitVec] * - `bit_vec` is not written to or read from concurrently */ -void sp_bitvec_fill(SPBitVec *bit_vec, bool value); +void sp_bitvec_fill(SPBitVec */*notnull*/ bit_vec, bool value); /** * Deallocates a [SPBitVec]. @@ -519,7 +624,7 @@ void sp_bitvec_fill(SPBitVec *bit_vec, bool value); * * [SPCommand]: [crate::SPCommand] */ -void sp_bitvec_free(SPBitVec *bit_vec); +void sp_bitvec_free(SPBitVec */*notnull*/ bit_vec); /** * Gets the value of a bit from the [SPBitVec]. @@ -543,7 +648,7 @@ void sp_bitvec_free(SPBitVec *bit_vec); * - `bit_vec` points to a valid [SPBitVec] * - `bit_vec` is not written to concurrently */ -bool sp_bitvec_get(const SPBitVec *bit_vec, size_t index); +bool sp_bitvec_get(SPBitVec */*notnull*/ bit_vec, size_t index); /** * Returns true if length is 0. @@ -562,7 +667,7 @@ bool sp_bitvec_get(const SPBitVec *bit_vec, size_t index); * * - `bit_vec` points to a valid [SPBitVec] */ -bool sp_bitvec_is_empty(const SPBitVec *bit_vec); +bool sp_bitvec_is_empty(SPBitVec */*notnull*/ bit_vec); /** * Gets the length of the [SPBitVec] in bits. @@ -581,7 +686,7 @@ bool sp_bitvec_is_empty(const SPBitVec *bit_vec); * * - `bit_vec` points to a valid [SPBitVec] */ -size_t sp_bitvec_len(const SPBitVec *bit_vec); +size_t sp_bitvec_len(SPBitVec */*notnull*/ bit_vec); /** * Interpret the data as a series of bits and load then into a new [SPBitVec] instance. @@ -601,8 +706,7 @@ size_t sp_bitvec_len(const SPBitVec *bit_vec); * - the returned instance is freed in some way, either by using a consuming function or * by explicitly calling `sp_bitvec_free`. */ -SPBitVec *sp_bitvec_load(const uint8_t *data, - size_t data_length); +SPBitVec */*notnull*/ sp_bitvec_load(SPByteSlice data); /** * Creates a new [SPBitVec] instance. @@ -624,7 +728,7 @@ SPBitVec *sp_bitvec_load(const uint8_t *data, * - the returned instance is freed in some way, either by using a consuming function or * by explicitly calling `sp_bitvec_free`. */ -SPBitVec *sp_bitvec_new(size_t size); +SPBitVec */*notnull*/ sp_bitvec_new(size_t size); /** * Sets the value of a bit in the [SPBitVec]. @@ -647,7 +751,7 @@ SPBitVec *sp_bitvec_new(size_t size); * - `bit_vec` points to a valid [SPBitVec] * - `bit_vec` is not written to or read from concurrently */ -void sp_bitvec_set(SPBitVec *bit_vec, size_t index, bool value); +void sp_bitvec_set(SPBitVec */*notnull*/ bit_vec, size_t index, bool value); /** * Gets an unsafe reference to the data of the [SPBitVec] instance. @@ -668,7 +772,7 @@ void sp_bitvec_set(SPBitVec *bit_vec, size_t index, bool value); * - the returned memory range is never accessed after the passed [SPBitVec] has been freed * - the returned memory range is never accessed concurrently, either via the [SPBitVec] or directly */ -SPByteSlice sp_bitvec_unsafe_data_ref(SPBitVec *bit_vec); +SPByteSlice sp_bitvec_unsafe_data_ref(SPBitVec */*notnull*/ bit_vec); /** * Clones a [SPBrightnessGrid]. @@ -692,7 +796,7 @@ SPByteSlice sp_bitvec_unsafe_data_ref(SPBitVec *bit_vec); * - the returned instance is freed in some way, either by using a consuming function or * by explicitly calling `sp_brightness_grid_free`. */ -SPBrightnessGrid *sp_brightness_grid_clone(const SPBrightnessGrid *brightness_grid); +BrightnessGrid */*notnull*/ sp_brightness_grid_clone(BrightnessGrid */*notnull*/ brightness_grid); /** * Sets the value of all cells in the [SPBrightnessGrid]. @@ -714,7 +818,8 @@ SPBrightnessGrid *sp_brightness_grid_clone(const SPBrightnessGrid *brightness_gr * - `brightness_grid` points to a valid [SPBrightnessGrid] * - `brightness_grid` is not written to or read from concurrently */ -void sp_brightness_grid_fill(SPBrightnessGrid *brightness_grid, uint8_t value); +void sp_brightness_grid_fill(BrightnessGrid */*notnull*/ brightness_grid, + uint8_t value); /** * Deallocates a [SPBrightnessGrid]. @@ -737,7 +842,7 @@ void sp_brightness_grid_fill(SPBrightnessGrid *brightness_grid, uint8_t value); * * [SPCommand]: [crate::SPCommand] */ -void sp_brightness_grid_free(SPBrightnessGrid *brightness_grid); +void sp_brightness_grid_free(BrightnessGrid */*notnull*/ brightness_grid); /** * Gets the current value at the specified position. @@ -761,7 +866,7 @@ void sp_brightness_grid_free(SPBrightnessGrid *brightness_grid); * - `brightness_grid` points to a valid [SPBrightnessGrid] * - `brightness_grid` is not written to concurrently */ -uint8_t sp_brightness_grid_get(const SPBrightnessGrid *brightness_grid, +uint8_t sp_brightness_grid_get(BrightnessGrid */*notnull*/ brightness_grid, size_t x, size_t y); @@ -784,7 +889,7 @@ uint8_t sp_brightness_grid_get(const SPBrightnessGrid *brightness_grid, * * - `brightness_grid` points to a valid [SPBrightnessGrid] */ -size_t sp_brightness_grid_height(const SPBrightnessGrid *brightness_grid); +size_t sp_brightness_grid_height(BrightnessGrid */*notnull*/ brightness_grid); /** * Loads a [SPBrightnessGrid] with the specified dimensions from the provided data. @@ -805,10 +910,9 @@ size_t sp_brightness_grid_height(const SPBrightnessGrid *brightness_grid); * - the returned instance is freed in some way, either by using a consuming function or * by explicitly calling `sp_brightness_grid_free`. */ -SPBrightnessGrid *sp_brightness_grid_load(size_t width, - size_t height, - const uint8_t *data, - size_t data_length); +BrightnessGrid *sp_brightness_grid_load(size_t width, + size_t height, + SPByteSlice data); /** * Creates a new [SPBrightnessGrid] with the specified dimensions. @@ -822,8 +926,8 @@ SPBrightnessGrid *sp_brightness_grid_load(size_t width, * - the returned instance is freed in some way, either by using a consuming function or * by explicitly calling `sp_brightness_grid_free`. */ -SPBrightnessGrid *sp_brightness_grid_new(size_t width, - size_t height); +BrightnessGrid */*notnull*/ sp_brightness_grid_new(size_t width, + size_t height); /** * Sets the value of the specified position in the [SPBrightnessGrid]. @@ -849,7 +953,7 @@ SPBrightnessGrid *sp_brightness_grid_new(size_t width, * - `brightness_grid` points to a valid [SPBrightnessGrid] * - `brightness_grid` is not written to or read from concurrently */ -void sp_brightness_grid_set(SPBrightnessGrid *brightness_grid, +void sp_brightness_grid_set(BrightnessGrid */*notnull*/ brightness_grid, size_t x, size_t y, uint8_t value); @@ -875,7 +979,7 @@ void sp_brightness_grid_set(SPBrightnessGrid *brightness_grid, * - the returned memory range is never accessed after the passed [SPBrightnessGrid] has been freed * - the returned memory range is never accessed concurrently, either via the [SPBrightnessGrid] or directly */ -SPByteSlice sp_brightness_grid_unsafe_data_ref(SPBrightnessGrid *brightness_grid); +SPByteSlice sp_brightness_grid_unsafe_data_ref(BrightnessGrid */*notnull*/ brightness_grid); /** * Gets the width of the [SPBrightnessGrid] instance. @@ -896,7 +1000,7 @@ SPByteSlice sp_brightness_grid_unsafe_data_ref(SPBrightnessGrid *brightness_grid * * - `brightness_grid` points to a valid [SPBrightnessGrid] */ -size_t sp_brightness_grid_width(const SPBrightnessGrid *brightness_grid); +size_t sp_brightness_grid_width(BrightnessGrid */*notnull*/ brightness_grid); /** * Clones a [SPCharGrid]. @@ -916,7 +1020,7 @@ size_t sp_brightness_grid_width(const SPBrightnessGrid *brightness_grid); * - the returned instance is freed in some way, either by using a consuming function or * by explicitly calling `sp_char_grid_free`. */ -SPCharGrid *sp_char_grid_clone(const SPCharGrid *char_grid); +CharGrid */*notnull*/ sp_char_grid_clone(CharGrid */*notnull*/ char_grid); /** * Sets the value of all cells in the [SPCharGrid]. @@ -937,7 +1041,7 @@ SPCharGrid *sp_char_grid_clone(const SPCharGrid *char_grid); * - `char_grid` points to a valid [SPCharGrid] * - `char_grid` is not written to or read from concurrently */ -void sp_char_grid_fill(SPCharGrid *char_grid, uint32_t value); +void sp_char_grid_fill(CharGrid */*notnull*/ char_grid, uint32_t value); /** * Deallocates a [SPCharGrid]. @@ -956,7 +1060,7 @@ void sp_char_grid_fill(SPCharGrid *char_grid, uint32_t value); * * [SPCommand]: [crate::SPCommand] */ -void sp_char_grid_free(SPCharGrid *char_grid); +void sp_char_grid_free(CharGrid */*notnull*/ char_grid); /** * Gets the current value at the specified position. @@ -978,7 +1082,7 @@ void sp_char_grid_free(SPCharGrid *char_grid); * - `char_grid` points to a valid [SPCharGrid] * - `char_grid` is not written to concurrently */ -uint32_t sp_char_grid_get(const SPCharGrid *char_grid, size_t x, size_t y); +uint32_t sp_char_grid_get(CharGrid */*notnull*/ char_grid, size_t x, size_t y); /** * Gets the height of the [SPCharGrid] instance. @@ -997,7 +1101,7 @@ uint32_t sp_char_grid_get(const SPCharGrid *char_grid, size_t x, size_t y); * * - `char_grid` points to a valid [SPCharGrid] */ -size_t sp_char_grid_height(const SPCharGrid *char_grid); +size_t sp_char_grid_height(CharGrid */*notnull*/ char_grid); /** * Loads a [SPCharGrid] with the specified dimensions from the provided data. @@ -1019,10 +1123,9 @@ size_t sp_char_grid_height(const SPCharGrid *char_grid); * - the returned instance is freed in some way, either by using a consuming function or * by explicitly calling `sp_char_grid_free`. */ -SPCharGrid *sp_char_grid_load(size_t width, - size_t height, - const uint8_t *data, - size_t data_length); +CharGrid */*notnull*/ sp_char_grid_load(size_t width, + size_t height, + SPByteSlice data); /** * Creates a new [SPCharGrid] with the specified dimensions. @@ -1036,8 +1139,8 @@ SPCharGrid *sp_char_grid_load(size_t width, * - the returned instance is freed in some way, either by using a consuming function or * by explicitly calling `sp_char_grid_free`. */ -SPCharGrid *sp_char_grid_new(size_t width, - size_t height); +CharGrid */*notnull*/ sp_char_grid_new(size_t width, + size_t height); /** * Sets the value of the specified position in the [SPCharGrid]. @@ -1064,7 +1167,7 @@ SPCharGrid *sp_char_grid_new(size_t width, * * [SPBitVec]: [crate::SPBitVec] */ -void sp_char_grid_set(SPCharGrid *char_grid, +void sp_char_grid_set(CharGrid */*notnull*/ char_grid, size_t x, size_t y, uint32_t value); @@ -1086,7 +1189,7 @@ void sp_char_grid_set(SPCharGrid *char_grid, * * - `char_grid` points to a valid [SPCharGrid] */ -size_t sp_char_grid_width(const SPCharGrid *char_grid); +size_t sp_char_grid_width(CharGrid */*notnull*/ char_grid); /** * Set pixel data starting at the pixel offset on screen. @@ -1115,9 +1218,9 @@ size_t sp_char_grid_width(const SPCharGrid *char_grid); * - the returned [SPCommand] instance is freed in some way, either by using a consuming function or * by explicitly calling `sp_command_free`. */ -SPCommand *sp_command_bitmap_linear(size_t offset, - SPBitVec *bit_vec, - SPCompressionCode compression); +Command *sp_command_bitmap_linear(size_t offset, + SPBitVec */*notnull*/ bit_vec, + CompressionCode compression); /** * Set pixel data according to an and-mask starting at the offset. @@ -1146,9 +1249,9 @@ SPCommand *sp_command_bitmap_linear(size_t offset, * - the returned [SPCommand] instance is freed in some way, either by using a consuming function or * by explicitly calling `sp_command_free`. */ -SPCommand *sp_command_bitmap_linear_and(size_t offset, - SPBitVec *bit_vec, - SPCompressionCode compression); +Command *sp_command_bitmap_linear_and(size_t offset, + SPBitVec */*notnull*/ bit_vec, + CompressionCode compression); /** * Set pixel data according to an or-mask starting at the offset. @@ -1177,9 +1280,9 @@ SPCommand *sp_command_bitmap_linear_and(size_t offset, * - the returned [SPCommand] instance is freed in some way, either by using a consuming function or * by explicitly calling `sp_command_free`. */ -SPCommand *sp_command_bitmap_linear_or(size_t offset, - SPBitVec *bit_vec, - SPCompressionCode compression); +Command *sp_command_bitmap_linear_or(size_t offset, + SPBitVec */*notnull*/ bit_vec, + CompressionCode compression); /** * Sets a window of pixels to the specified values. @@ -1203,10 +1306,10 @@ SPCommand *sp_command_bitmap_linear_or(size_t offset, * - the returned [SPCommand] instance is freed in some way, either by using a consuming function or * by explicitly calling `sp_command_free`. */ -SPCommand *sp_command_bitmap_linear_win(size_t x, - size_t y, - SPBitmap *bitmap, - SPCompressionCode compression_code); +Command *sp_command_bitmap_linear_win(size_t x, + size_t y, + Bitmap */*notnull*/ bitmap, + CompressionCode compression); /** * Set pixel data according to a xor-mask starting at the offset. @@ -1235,9 +1338,9 @@ SPCommand *sp_command_bitmap_linear_win(size_t x, * - the returned [SPCommand] instance is freed in some way, either by using a consuming function or * by explicitly calling `sp_command_free`. */ -SPCommand *sp_command_bitmap_linear_xor(size_t offset, - SPBitVec *bit_vec, - SPCompressionCode compression); +Command *sp_command_bitmap_linear_xor(size_t offset, + SPBitVec */*notnull*/ bit_vec, + CompressionCode compression); /** * Set the brightness of all tiles to the same value. @@ -1255,7 +1358,7 @@ SPCommand *sp_command_bitmap_linear_xor(size_t offset, * - the returned [SPCommand] instance is freed in some way, either by using a consuming function or * by explicitly calling `sp_command_free`. */ -SPCommand *sp_command_brightness(uint8_t brightness); +Command */*notnull*/ sp_command_brightness(uint8_t brightness); /** * Set the brightness of individual tiles in a rectangular area of the display. @@ -1277,9 +1380,9 @@ SPCommand *sp_command_brightness(uint8_t brightness); * - the returned [SPCommand] instance is freed in some way, either by using a consuming function or * by explicitly calling `sp_command_free`. */ -SPCommand *sp_command_char_brightness(size_t x, - size_t y, - SPBrightnessGrid *grid); +Command */*notnull*/ sp_command_char_brightness(size_t x, + size_t y, + BrightnessGrid */*notnull*/ grid); /** * Set all pixels to the off state. @@ -1301,7 +1404,7 @@ SPCommand *sp_command_char_brightness(size_t x, * - the returned [SPCommand] instance is freed in some way, either by using a consuming function or * by explicitly calling `sp_command_free`. */ -SPCommand *sp_command_clear(void); +Command */*notnull*/ sp_command_clear(void); /** * Clones a [SPCommand] instance. @@ -1321,7 +1424,7 @@ SPCommand *sp_command_clear(void); * - the returned [SPCommand] instance is freed in some way, either by using a consuming function or * by explicitly calling `sp_command_free`. */ -SPCommand *sp_command_clone(const SPCommand *command); +Command */*notnull*/ sp_command_clone(Command */*notnull*/ command); /** * Show codepage 437 encoded text on the screen. @@ -1343,9 +1446,9 @@ SPCommand *sp_command_clone(const SPCommand *command); * - the returned [SPCommand] instance is freed in some way, either by using a consuming function or * by explicitly calling `sp_command_free`. */ -SPCommand *sp_command_cp437_data(size_t x, - size_t y, - SPCp437Grid *grid); +Command */*notnull*/ sp_command_cp437_data(size_t x, + size_t y, + Cp437Grid */*notnull*/ grid); /** * A yet-to-be-tested command. @@ -1359,7 +1462,7 @@ SPCommand *sp_command_cp437_data(size_t x, * - the returned [SPCommand] instance is freed in some way, either by using a consuming function or * by explicitly calling `sp_command_free`. */ -SPCommand *sp_command_fade_out(void); +Command */*notnull*/ sp_command_fade_out(void); /** * Deallocates a [SPCommand]. @@ -1383,7 +1486,7 @@ SPCommand *sp_command_fade_out(void); * - `command` is not used concurrently or after this call * - `command` was not passed to another consuming function, e.g. to create a [SPPacket] */ -void sp_command_free(SPCommand *command); +void sp_command_free(Command */*notnull*/ command); /** * Kills the udp daemon on the display, which usually results in a restart. @@ -1399,9 +1502,23 @@ void sp_command_free(SPCommand *command); * - the returned [SPCommand] instance is freed in some way, either by using a consuming function or * by explicitly calling `sp_command_free`. */ -SPCommand *sp_command_hard_reset(void); +Command */*notnull*/ sp_command_hard_reset(void); /** + * A low-level display command. + * + * This struct and associated functions implement the UDP protocol for the display. + * + * To send a [SPCommand], use a [SPConnection]. + * + * # Examples + * + * ```C + * sp_connection_send_command(connection, sp_command_clear()); + * sp_connection_send_command(connection, sp_command_brightness(5)); + * ``` + * + * [SPConnection]: [crate::SPConnection] * Tries to turn a [SPPacket] into a [SPCommand]. * * The packet is deallocated in the process. @@ -1422,7 +1539,7 @@ SPCommand *sp_command_hard_reset(void); * - the returned [SPCommand] instance is freed in some way, either by using a consuming function or * by explicitly calling `sp_command_free`. */ -SPCommand *sp_command_try_from_packet(SPPacket *packet); +Command *sp_command_try_from_packet(Packet */*notnull*/ packet); /** * Show UTF-8 encoded text on the screen. @@ -1444,23 +1561,9 @@ SPCommand *sp_command_try_from_packet(SPPacket *packet); * - the returned [SPCommand] instance is freed in some way, either by using a consuming function or * by explicitly calling `sp_command_free`. */ -SPCommand *sp_command_utf8_data(size_t x, - size_t y, - SPCharGrid *grid); - -/** - * Creates a new instance of [SPConnection] for testing that does not actually send anything. - * - * returns: a new instance. Will never return NULL. - * - * # Safety - * - * The caller has to make sure that: - * - * - the returned instance is freed in some way, either by using a consuming function or - * by explicitly calling `sp_connection_free`. - */ -SPConnection *sp_connection_fake(void); +Command */*notnull*/ sp_command_utf8_data(size_t x, + size_t y, + CharGrid */*notnull*/ grid); /** * Closes and deallocates a [SPConnection]. @@ -1476,7 +1579,7 @@ SPConnection *sp_connection_fake(void); * - `connection` points to a valid [SPConnection] * - `connection` is not used concurrently or after this call */ -void sp_connection_free(SPConnection *connection); +void sp_connection_free(UdpConnection */*notnull*/ connection); /** * Creates a new instance of [SPConnection]. @@ -1494,7 +1597,7 @@ void sp_connection_free(SPConnection *connection); * - the returned instance is freed in some way, either by using a consuming function or * by explicitly calling `sp_connection_free`. */ -SPConnection *sp_connection_open(const char *host); +UdpConnection *sp_connection_open(char */*notnull*/ host); /** * Sends a [SPCommand] to the display using the [SPConnection]. @@ -1516,8 +1619,8 @@ SPConnection *sp_connection_open(const char *host); * - `command` points to a valid instance of [SPPacket] * - `command` is not used concurrently or after this call */ -bool sp_connection_send_command(const SPConnection *connection, - SPCommand *command); +bool sp_connection_send_command(UdpConnection */*notnull*/ connection, + Command */*notnull*/ command); /** * Sends a [SPPacket] to the display using the [SPConnection]. @@ -1539,8 +1642,8 @@ bool sp_connection_send_command(const SPConnection *connection, * - `packet` points to a valid instance of [SPPacket] * - `packet` is not used concurrently or after this call */ -bool sp_connection_send_packet(const SPConnection *connection, - SPPacket *packet); +bool sp_connection_send_packet(UdpConnection */*notnull*/ connection, + Packet */*notnull*/ packet); /** * Clones a [SPCp437Grid]. @@ -1560,7 +1663,7 @@ bool sp_connection_send_packet(const SPConnection *connection, * - the returned instance is freed in some way, either by using a consuming function or * by explicitly calling `sp_cp437_grid_free`. */ -SPCp437Grid *sp_cp437_grid_clone(const SPCp437Grid *cp437_grid); +Cp437Grid */*notnull*/ sp_cp437_grid_clone(Cp437Grid */*notnull*/ cp437_grid); /** * Sets the value of all cells in the [SPCp437Grid]. @@ -1581,7 +1684,7 @@ SPCp437Grid *sp_cp437_grid_clone(const SPCp437Grid *cp437_grid); * - `cp437_grid` points to a valid [SPCp437Grid] * - `cp437_grid` is not written to or read from concurrently */ -void sp_cp437_grid_fill(SPCp437Grid *cp437_grid, uint8_t value); +void sp_cp437_grid_fill(Cp437Grid */*notnull*/ cp437_grid, uint8_t value); /** * Deallocates a [SPCp437Grid]. @@ -1600,7 +1703,7 @@ void sp_cp437_grid_fill(SPCp437Grid *cp437_grid, uint8_t value); * * [SPCommand]: [crate::SPCommand] */ -void sp_cp437_grid_free(SPCp437Grid *cp437_grid); +void sp_cp437_grid_free(Cp437Grid */*notnull*/ cp437_grid); /** * Gets the current value at the specified position. @@ -1622,7 +1725,9 @@ void sp_cp437_grid_free(SPCp437Grid *cp437_grid); * - `cp437_grid` points to a valid [SPCp437Grid] * - `cp437_grid` is not written to concurrently */ -uint8_t sp_cp437_grid_get(const SPCp437Grid *cp437_grid, size_t x, size_t y); +uint8_t sp_cp437_grid_get(Cp437Grid */*notnull*/ cp437_grid, + size_t x, + size_t y); /** * Gets the height of the [SPCp437Grid] instance. @@ -1641,7 +1746,7 @@ uint8_t sp_cp437_grid_get(const SPCp437Grid *cp437_grid, size_t x, size_t y); * * - `cp437_grid` points to a valid [SPCp437Grid] */ -size_t sp_cp437_grid_height(const SPCp437Grid *cp437_grid); +size_t sp_cp437_grid_height(Cp437Grid */*notnull*/ cp437_grid); /** * Loads a [SPCp437Grid] with the specified dimensions from the provided data. @@ -1662,10 +1767,9 @@ size_t sp_cp437_grid_height(const SPCp437Grid *cp437_grid); * - the returned instance is freed in some way, either by using a consuming function or * by explicitly calling `sp_cp437_grid_free`. */ -SPCp437Grid *sp_cp437_grid_load(size_t width, - size_t height, - const uint8_t *data, - size_t data_length); +Cp437Grid *sp_cp437_grid_load(size_t width, + size_t height, + SPByteSlice data); /** * Creates a new [SPCp437Grid] with the specified dimensions. @@ -1679,8 +1783,8 @@ SPCp437Grid *sp_cp437_grid_load(size_t width, * - the returned instance is freed in some way, either by using a consuming function or * by explicitly calling `sp_cp437_grid_free`. */ -SPCp437Grid *sp_cp437_grid_new(size_t width, - size_t height); +Cp437Grid */*notnull*/ sp_cp437_grid_new(size_t width, + size_t height); /** * Sets the value of the specified position in the [SPCp437Grid]. @@ -1707,7 +1811,7 @@ SPCp437Grid *sp_cp437_grid_new(size_t width, * * [SPBitVec]: [crate::SPBitVec] */ -void sp_cp437_grid_set(SPCp437Grid *cp437_grid, +void sp_cp437_grid_set(Cp437Grid */*notnull*/ cp437_grid, size_t x, size_t y, uint8_t value); @@ -1729,7 +1833,7 @@ void sp_cp437_grid_set(SPCp437Grid *cp437_grid, * - the returned memory range is never accessed after the passed [SPCp437Grid] has been freed * - the returned memory range is never accessed concurrently, either via the [SPCp437Grid] or directly */ -SPByteSlice sp_cp437_grid_unsafe_data_ref(SPCp437Grid *cp437_grid); +SPByteSlice sp_cp437_grid_unsafe_data_ref(Cp437Grid */*notnull*/ cp437_grid); /** * Gets the width of the [SPCp437Grid] instance. @@ -1748,7 +1852,7 @@ SPByteSlice sp_cp437_grid_unsafe_data_ref(SPCp437Grid *cp437_grid); * * - `cp437_grid` points to a valid [SPCp437Grid] */ -size_t sp_cp437_grid_width(const SPCp437Grid *cp437_grid); +size_t sp_cp437_grid_width(Cp437Grid */*notnull*/ cp437_grid); /** * Clones a [SPPacket]. @@ -1768,7 +1872,7 @@ size_t sp_cp437_grid_width(const SPCp437Grid *cp437_grid); * - the returned instance is freed in some way, either by using a consuming function or * by explicitly calling `sp_packet_free`. */ -SPPacket *sp_packet_clone(const SPPacket *packet); +Packet */*notnull*/ sp_packet_clone(Packet */*notnull*/ packet); /** * Deallocates a [SPPacket]. @@ -1784,7 +1888,7 @@ SPPacket *sp_packet_clone(const SPPacket *packet); * - `packet` points to a valid [SPPacket] * - `packet` is not used concurrently or after this call */ -void sp_packet_free(SPPacket *packet); +void sp_packet_free(Packet */*notnull*/ packet); /** * Turns a [SPCommand] into a [SPPacket]. @@ -1805,7 +1909,7 @@ void sp_packet_free(SPPacket *packet); * - the returned [SPPacket] instance is freed in some way, either by using a consuming function or * by explicitly calling `sp_packet_free`. */ -SPPacket *sp_packet_from_command(SPCommand *command); +Packet *sp_packet_from_command(Command */*notnull*/ command); /** * Creates a raw [SPPacket] from parts. @@ -1833,13 +1937,14 @@ SPPacket *sp_packet_from_command(SPCommand *command); * - the returned [SPPacket] instance is freed in some way, either by using a consuming function or * by explicitly calling [sp_packet_free]. */ -SPPacket *sp_packet_from_parts(uint16_t command_code, - uint16_t a, - uint16_t b, - uint16_t c, - uint16_t d, - const uint8_t *payload, - size_t payload_len); +Packet */*notnull*/ sp_packet_from_parts(Header header, + const SPByteSlice *payload); + +Header */*notnull*/ sp_packet_get_header(Packet */*notnull*/ packet); + +SPByteSlice sp_packet_get_payload(Packet */*notnull*/ packet); + +void sp_packet_set_payload(Packet */*notnull*/ packet, SPByteSlice data); /** * Tries to load a [SPPacket] from the passed array with the specified length. @@ -1859,8 +1964,9 @@ SPPacket *sp_packet_from_parts(uint16_t command_code, * - the returned [SPPacket] instance is freed in some way, either by using a consuming function or * by explicitly calling `sp_packet_free`. */ -SPPacket *sp_packet_try_load(const uint8_t *data, - size_t length); +Packet *sp_packet_try_load(SPByteSlice data); + +void sp_packet_write_to(Packet */*notnull*/ packet, SPByteSlice buffer); #ifdef __cplusplus } // extern "C" diff --git a/examples/lang_c/src/main.c b/examples/lang_c/src/main.c index 1454804..80a1756 100644 --- a/examples/lang_c/src/main.c +++ b/examples/lang_c/src/main.c @@ -2,15 +2,26 @@ #include "servicepoint.h" int main(void) { - SPConnection *connection = sp_connection_open("localhost:2342"); + UdpConnection *connection = sp_connection_open("localhost:2342"); if (connection == NULL) return 1; - SPBitmap *pixels = sp_bitmap_new(SP_PIXEL_WIDTH, SP_PIXEL_HEIGHT); + Bitmap *pixels = sp_bitmap_new(PIXEL_WIDTH, PIXEL_HEIGHT); + if (pixels == NULL) + return 1; + sp_bitmap_fill(pixels, true); - SPCommand *command = sp_command_bitmap_linear_win(0, 0, pixels, SP_COMPRESSION_CODE_UNCOMPRESSED); - sp_connection_send_command(connection, command); + Command *command = sp_command_bitmap_linear_win(0, 0, pixels, COMPRESSION_CODE_UNCOMPRESSED); + if (command == NULL) + return 1; + + Packet *packet = sp_packet_from_command(command); + + Header *header = sp_packet_get_header(packet); + printf("[%d, %d, %d, %d, %d]\n", header->command_code, header->a, header->b, header->c, header->d); + + sp_connection_send_packet(connection, packet); sp_connection_free(connection); return 0; diff --git a/flake.nix b/flake.nix index 9318237..1f0ac97 100644 --- a/flake.nix +++ b/flake.nix @@ -33,25 +33,35 @@ { pkgs, system }: { default = pkgs.mkShell rec { - packages = with pkgs; [ + buildInputs = with pkgs;[ + xe + xz + libgcc + #glibc.static + musl + libunwind + ]; + + nativeBuildInputs = with pkgs;[ (pkgs.symlinkJoin { name = "rust-toolchain"; paths = with pkgs; [ - rustc - cargo - rustPlatform.rustcSrc - rustfmt - clippy + #rustc + #cargo + #rustPlatform.rustcSrc + #rustfmt + #clippy cargo-expand cargo-tarpaulin + rustup ]; }) gcc gnumake - xe - xz pkg-config + ]; + RUST_SRC_PATH = "${pkgs.rust.packages.stable.rustPlatform.rustLibSrc}"; }; } diff --git a/src/bitmap.rs b/src/bitmap.rs index 3313385..2e70efc 100644 --- a/src/bitmap.rs +++ b/src/bitmap.rs @@ -1,24 +1,23 @@ //! C functions for interacting with [SPBitmap]s //! //! prefix `sp_bitmap_` +//! +//! A grid of pixels. +//! +//! # Examples +//! +//! ```C +//! Cp437Grid grid = sp_bitmap_new(8, 3); +//! sp_bitmap_fill(grid, true); +//! sp_bitmap_set(grid, 0, 0, false); +//! sp_bitmap_free(grid); +//! ``` -use servicepoint::{DataRef, Grid}; +use servicepoint::{Bitmap, DataRef, Grid}; use std::ptr::NonNull; use crate::byte_slice::SPByteSlice; -/// A grid of pixels. -/// -/// # Examples -/// -/// ```C -/// Cp437Grid grid = sp_bitmap_new(8, 3); -/// sp_bitmap_fill(grid, true); -/// sp_bitmap_set(grid, 0, 0, false); -/// sp_bitmap_free(grid); -/// ``` -pub struct SPBitmap(pub(crate) servicepoint::Bitmap); - /// Creates a new [SPBitmap] with the specified dimensions. /// /// # Arguments @@ -26,9 +25,11 @@ pub struct SPBitmap(pub(crate) servicepoint::Bitmap); /// - `width`: size in pixels in x-direction /// - `height`: size in pixels in y-direction /// -/// returns: [SPBitmap] initialized to all pixels off. Will never return NULL. +/// returns: [SPBitmap] initialized to all pixels off, or NULL in case of an error. /// -/// # Panics +/// # Errors +/// +/// In the following cases, this function will return NULL: /// /// - when the width is not dividable by 8 /// @@ -42,9 +43,12 @@ pub struct SPBitmap(pub(crate) servicepoint::Bitmap); pub unsafe extern "C" fn sp_bitmap_new( width: usize, height: usize, -) -> NonNull { - let result = Box::new(SPBitmap(servicepoint::Bitmap::new(width, height))); - NonNull::from(Box::leak(result)) +) -> *mut Bitmap { + if let Some(bitmap) = Bitmap::new(width, height) { + Box::leak(Box::new(bitmap)) + } else { + std::ptr::null_mut() + } } /// Creates a new [SPBitmap] with a size matching the screen. @@ -58,8 +62,8 @@ pub unsafe extern "C" fn sp_bitmap_new( /// - the returned instance is freed in some way, either by using a consuming function or /// by explicitly calling [sp_bitmap_free]. #[no_mangle] -pub unsafe extern "C" fn sp_bitmap_new_screen_sized() -> NonNull { - let result = Box::new(SPBitmap(servicepoint::Bitmap::max_sized())); +pub unsafe extern "C" fn sp_bitmap_new_screen_sized() -> NonNull { + let result = Box::new(Bitmap::max_sized()); NonNull::from(Box::leak(result)) } @@ -70,13 +74,18 @@ pub unsafe extern "C" fn sp_bitmap_new_screen_sized() -> NonNull { /// - `width`: size in pixels in x-direction /// - `height`: size in pixels in y-direction /// -/// returns: [SPBitmap] that contains a copy of the provided data. Will never return NULL. +/// returns: [SPBitmap] that contains a copy of the provided data, or NULL in case of an error. +/// +/// # Errors +/// +/// In the following cases, this function will return NULL: +/// +/// - when the dimensions and data size do not match exactly. +/// - when the width is not dividable by 8 /// /// # Panics /// /// - when `data` is NULL -/// - when the dimensions and data size do not match exactly. -/// - when the width is not dividable by 8 /// /// # Safety /// @@ -89,14 +98,14 @@ pub unsafe extern "C" fn sp_bitmap_new_screen_sized() -> NonNull { pub unsafe extern "C" fn sp_bitmap_load( width: usize, height: usize, - data: *const u8, - data_length: usize, -) -> NonNull { - assert!(!data.is_null()); - let data = std::slice::from_raw_parts(data, data_length); - let result = - Box::new(SPBitmap(servicepoint::Bitmap::load(width, height, data))); - NonNull::from(Box::leak(result)) + data: SPByteSlice, +) -> *mut Bitmap { + let data = unsafe { data.as_slice() }; + if let Ok(bitmap) = Bitmap::load(width, height, data) { + Box::leak(Box::new(bitmap)) + } else { + std::ptr::null_mut() + } } /// Clones a [SPBitmap]. @@ -117,10 +126,9 @@ pub unsafe extern "C" fn sp_bitmap_load( /// by explicitly calling `sp_bitmap_free`. #[no_mangle] pub unsafe extern "C" fn sp_bitmap_clone( - bitmap: *const SPBitmap, -) -> NonNull { - assert!(!bitmap.is_null()); - let result = Box::new(SPBitmap((*bitmap).0.clone())); + bitmap: NonNull, +) -> NonNull { + let result = Box::new(unsafe { bitmap.as_ref().clone() }); NonNull::from(Box::leak(result)) } @@ -135,14 +143,11 @@ pub unsafe extern "C" fn sp_bitmap_clone( /// The caller has to make sure that: /// /// - `bitmap` points to a valid [SPBitmap] -/// - `bitmap` is not used concurrently or after bitmap call -/// - `bitmap` was not passed to another consuming function, e.g. to create a [SPCommand] /// /// [SPCommand]: [crate::SPCommand] #[no_mangle] -pub unsafe extern "C" fn sp_bitmap_free(bitmap: *mut SPBitmap) { - assert!(!bitmap.is_null()); - _ = Box::from_raw(bitmap); +pub unsafe extern "C" fn sp_bitmap_free(bitmap: NonNull) { + _ = unsafe { Box::from_raw(bitmap.as_ptr()) }; } /// Gets the current value at the specified position in the [SPBitmap]. @@ -165,12 +170,11 @@ pub unsafe extern "C" fn sp_bitmap_free(bitmap: *mut SPBitmap) { /// - `bitmap` is not written to concurrently #[no_mangle] pub unsafe extern "C" fn sp_bitmap_get( - bitmap: *const SPBitmap, + bitmap: NonNull, x: usize, y: usize, ) -> bool { - assert!(!bitmap.is_null()); - (*bitmap).0.get(x, y) + unsafe { bitmap.as_ref().get(x, y) } } /// Sets the value of the specified position in the [SPBitmap]. @@ -196,13 +200,12 @@ pub unsafe extern "C" fn sp_bitmap_get( /// - `bitmap` is not written to or read from concurrently #[no_mangle] pub unsafe extern "C" fn sp_bitmap_set( - bitmap: *mut SPBitmap, + bitmap: NonNull, x: usize, y: usize, value: bool, ) { - assert!(!bitmap.is_null()); - (*bitmap).0.set(x, y, value); + unsafe { (*bitmap.as_ptr()).set(x, y, value) }; } /// Sets the state of all pixels in the [SPBitmap]. @@ -223,9 +226,8 @@ pub unsafe extern "C" fn sp_bitmap_set( /// - `bitmap` points to a valid [SPBitmap] /// - `bitmap` is not written to or read from concurrently #[no_mangle] -pub unsafe extern "C" fn sp_bitmap_fill(bitmap: *mut SPBitmap, value: bool) { - assert!(!bitmap.is_null()); - (*bitmap).0.fill(value); +pub unsafe extern "C" fn sp_bitmap_fill(bitmap: NonNull, value: bool) { + unsafe { (*bitmap.as_ptr()).fill(value) }; } /// Gets the width in pixels of the [SPBitmap] instance. @@ -244,9 +246,8 @@ pub unsafe extern "C" fn sp_bitmap_fill(bitmap: *mut SPBitmap, value: bool) { /// /// - `bitmap` points to a valid [SPBitmap] #[no_mangle] -pub unsafe extern "C" fn sp_bitmap_width(bitmap: *const SPBitmap) -> usize { - assert!(!bitmap.is_null()); - (*bitmap).0.width() +pub unsafe extern "C" fn sp_bitmap_width(bitmap: NonNull) -> usize { + unsafe { bitmap.as_ref().width() } } /// Gets the height in pixels of the [SPBitmap] instance. @@ -265,9 +266,8 @@ pub unsafe extern "C" fn sp_bitmap_width(bitmap: *const SPBitmap) -> usize { /// /// - `bitmap` points to a valid [SPBitmap] #[no_mangle] -pub unsafe extern "C" fn sp_bitmap_height(bitmap: *const SPBitmap) -> usize { - assert!(!bitmap.is_null()); - (*bitmap).0.height() +pub unsafe extern "C" fn sp_bitmap_height(bitmap: NonNull) -> usize { + unsafe { bitmap.as_ref().height() } } /// Gets an unsafe reference to the data of the [SPBitmap] instance. @@ -285,12 +285,7 @@ pub unsafe extern "C" fn sp_bitmap_height(bitmap: *const SPBitmap) -> usize { /// - the returned memory range is never accessed concurrently, either via the [SPBitmap] or directly #[no_mangle] pub unsafe extern "C" fn sp_bitmap_unsafe_data_ref( - bitmap: *mut SPBitmap, + mut bitmap: NonNull, ) -> SPByteSlice { - assert!(!bitmap.is_null()); - let data = (*bitmap).0.data_ref_mut(); - SPByteSlice { - start: NonNull::new(data.as_mut_ptr_range().start).unwrap(), - length: data.len(), - } + unsafe { SPByteSlice::from_slice(bitmap.as_mut().data_ref_mut()) } } diff --git a/src/bitvec.rs b/src/bitvec.rs index 484e849..c32ce78 100644 --- a/src/bitvec.rs +++ b/src/bitvec.rs @@ -13,19 +13,7 @@ use std::ptr::NonNull; /// sp_bitvec_set(vec, 5, true); /// sp_bitvec_free(vec); /// ``` -pub struct SPBitVec(servicepoint::BitVec); - -impl From for SPBitVec { - fn from(actual: servicepoint::BitVec) -> Self { - Self(actual) - } -} - -impl From for servicepoint::BitVec { - fn from(value: SPBitVec) -> Self { - value.0 - } -} +pub struct SPBitVec(pub(crate) servicepoint::BitVecU8Msb0); impl Clone for SPBitVec { fn clone(&self) -> Self { @@ -53,7 +41,8 @@ impl Clone for SPBitVec { /// by explicitly calling `sp_bitvec_free`. #[no_mangle] pub unsafe extern "C" fn sp_bitvec_new(size: usize) -> NonNull { - let result = Box::new(SPBitVec(servicepoint::BitVec::repeat(false, size))); + let result = + Box::new(SPBitVec(servicepoint::BitVecU8Msb0::repeat(false, size))); NonNull::from(Box::leak(result)) } @@ -75,12 +64,11 @@ pub unsafe extern "C" fn sp_bitvec_new(size: usize) -> NonNull { /// by explicitly calling `sp_bitvec_free`. #[no_mangle] pub unsafe extern "C" fn sp_bitvec_load( - data: *const u8, - data_length: usize, + data: SPByteSlice, ) -> NonNull { - assert!(!data.is_null()); - let data = std::slice::from_raw_parts(data, data_length); - let result = Box::new(SPBitVec(servicepoint::BitVec::from_slice(data))); + let data = unsafe { data.as_slice() }; + let result = + Box::new(SPBitVec(servicepoint::BitVecU8Msb0::from_slice(data))); NonNull::from(Box::leak(result)) } @@ -102,10 +90,9 @@ pub unsafe extern "C" fn sp_bitvec_load( /// by explicitly calling `sp_bitvec_free`. #[no_mangle] pub unsafe extern "C" fn sp_bitvec_clone( - bit_vec: *const SPBitVec, + bit_vec: NonNull, ) -> NonNull { - assert!(!bit_vec.is_null()); - let result = Box::new((*bit_vec).clone()); + let result = Box::new(unsafe { bit_vec.as_ref().clone() }); NonNull::from(Box::leak(result)) } @@ -125,9 +112,8 @@ pub unsafe extern "C" fn sp_bitvec_clone( /// /// [SPCommand]: [crate::SPCommand] #[no_mangle] -pub unsafe extern "C" fn sp_bitvec_free(bit_vec: *mut SPBitVec) { - assert!(!bit_vec.is_null()); - _ = Box::from_raw(bit_vec); +pub unsafe extern "C" fn sp_bitvec_free(bit_vec: NonNull) { + _ = unsafe { Box::from_raw(bit_vec.as_ptr()) }; } /// Gets the value of a bit from the [SPBitVec]. @@ -152,11 +138,10 @@ pub unsafe extern "C" fn sp_bitvec_free(bit_vec: *mut SPBitVec) { /// - `bit_vec` is not written to concurrently #[no_mangle] pub unsafe extern "C" fn sp_bitvec_get( - bit_vec: *const SPBitVec, + bit_vec: NonNull, index: usize, ) -> bool { - assert!(!bit_vec.is_null()); - *(*bit_vec).0.get(index).unwrap() + unsafe { *bit_vec.as_ref().0.get(index).unwrap() } } /// Sets the value of a bit in the [SPBitVec]. @@ -180,12 +165,11 @@ pub unsafe extern "C" fn sp_bitvec_get( /// - `bit_vec` is not written to or read from concurrently #[no_mangle] pub unsafe extern "C" fn sp_bitvec_set( - bit_vec: *mut SPBitVec, + bit_vec: NonNull, index: usize, value: bool, ) { - assert!(!bit_vec.is_null()); - (*bit_vec).0.set(index, value) + unsafe { (*bit_vec.as_ptr()).0.set(index, value) } } /// Sets the value of all bits in the [SPBitVec]. @@ -206,9 +190,11 @@ pub unsafe extern "C" fn sp_bitvec_set( /// - `bit_vec` points to a valid [SPBitVec] /// - `bit_vec` is not written to or read from concurrently #[no_mangle] -pub unsafe extern "C" fn sp_bitvec_fill(bit_vec: *mut SPBitVec, value: bool) { - assert!(!bit_vec.is_null()); - (*bit_vec).0.fill(value) +pub unsafe extern "C" fn sp_bitvec_fill( + bit_vec: NonNull, + value: bool, +) { + unsafe { (*bit_vec.as_ptr()).0.fill(value) } } /// Gets the length of the [SPBitVec] in bits. @@ -227,9 +213,8 @@ pub unsafe extern "C" fn sp_bitvec_fill(bit_vec: *mut SPBitVec, value: bool) { /// /// - `bit_vec` points to a valid [SPBitVec] #[no_mangle] -pub unsafe extern "C" fn sp_bitvec_len(bit_vec: *const SPBitVec) -> usize { - assert!(!bit_vec.is_null()); - (*bit_vec).0.len() +pub unsafe extern "C" fn sp_bitvec_len(bit_vec: NonNull) -> usize { + unsafe { bit_vec.as_ref().0.len() } } /// Returns true if length is 0. @@ -248,9 +233,10 @@ pub unsafe extern "C" fn sp_bitvec_len(bit_vec: *const SPBitVec) -> usize { /// /// - `bit_vec` points to a valid [SPBitVec] #[no_mangle] -pub unsafe extern "C" fn sp_bitvec_is_empty(bit_vec: *const SPBitVec) -> bool { - assert!(!bit_vec.is_null()); - (*bit_vec).0.is_empty() +pub unsafe extern "C" fn sp_bitvec_is_empty( + bit_vec: NonNull, +) -> bool { + unsafe { bit_vec.as_ref().0.is_empty() } } /// Gets an unsafe reference to the data of the [SPBitVec] instance. @@ -272,12 +258,7 @@ pub unsafe extern "C" fn sp_bitvec_is_empty(bit_vec: *const SPBitVec) -> bool { /// - the returned memory range is never accessed concurrently, either via the [SPBitVec] or directly #[no_mangle] pub unsafe extern "C" fn sp_bitvec_unsafe_data_ref( - bit_vec: *mut SPBitVec, + bit_vec: NonNull, ) -> SPByteSlice { - assert!(!bit_vec.is_null()); - let data = (*bit_vec).0.as_raw_mut_slice(); - SPByteSlice { - start: NonNull::new(data.as_mut_ptr_range().start).unwrap(), - length: data.len(), - } + unsafe { SPByteSlice::from_slice((*bit_vec.as_ptr()).0.as_raw_mut_slice()) } } diff --git a/src/brightness_grid.rs b/src/brightness_grid.rs index 83af008..c6abbb4 100644 --- a/src/brightness_grid.rs +++ b/src/brightness_grid.rs @@ -1,11 +1,28 @@ //! C functions for interacting with [SPBrightnessGrid]s //! //! prefix `sp_brightness_grid_` +//! +//! +//! A grid containing brightness values. +//! +//! # Examples +//! ```C +//! SPConnection connection = sp_connection_open("127.0.0.1:2342"); +//! if (connection == NULL) +//! return 1; +//! +//! SPBrightnessGrid grid = sp_brightness_grid_new(2, 2); +//! sp_brightness_grid_set(grid, 0, 0, 0); +//! sp_brightness_grid_set(grid, 1, 1, 10); +//! +//! SPCommand command = sp_command_char_brightness(grid); +//! sp_connection_free(connection); +//! ``` use crate::SPByteSlice; -use servicepoint::{DataRef, Grid}; +use servicepoint::{BrightnessGrid, DataRef, Grid}; use std::convert::Into; -use std::intrinsics::transmute; +use std::mem::transmute; use std::ptr::NonNull; /// see [servicepoint::Brightness::MIN] @@ -15,24 +32,6 @@ pub const SP_BRIGHTNESS_MAX: u8 = 11; /// Count of possible brightness values pub const SP_BRIGHTNESS_LEVELS: u8 = 12; -/// A grid containing brightness values. -/// -/// # Examples -/// ```C -/// SPConnection connection = sp_connection_open("127.0.0.1:2342"); -/// if (connection == NULL) -/// return 1; -/// -/// SPBrightnessGrid grid = sp_brightness_grid_new(2, 2); -/// sp_brightness_grid_set(grid, 0, 0, 0); -/// sp_brightness_grid_set(grid, 1, 1, 10); -/// -/// SPCommand command = sp_command_char_brightness(grid); -/// sp_connection_free(connection); -/// ``` -#[derive(Clone)] -pub struct SPBrightnessGrid(pub(crate) servicepoint::BrightnessGrid); - /// Creates a new [SPBrightnessGrid] with the specified dimensions. /// /// returns: [SPBrightnessGrid] initialized to 0. Will never return NULL. @@ -47,10 +46,8 @@ pub struct SPBrightnessGrid(pub(crate) servicepoint::BrightnessGrid); pub unsafe extern "C" fn sp_brightness_grid_new( width: usize, height: usize, -) -> NonNull { - let result = Box::new(SPBrightnessGrid(servicepoint::BrightnessGrid::new( - width, height, - ))); +) -> NonNull { + let result = Box::new(BrightnessGrid::new(width, height)); NonNull::from(Box::leak(result)) } @@ -75,16 +72,18 @@ pub unsafe extern "C" fn sp_brightness_grid_new( pub unsafe extern "C" fn sp_brightness_grid_load( width: usize, height: usize, - data: *const u8, - data_length: usize, -) -> NonNull { - assert!(!data.is_null()); - let data = std::slice::from_raw_parts(data, data_length); - let grid = servicepoint::ByteGrid::load(width, height, data); - let grid = servicepoint::BrightnessGrid::try_from(grid) - .expect("invalid brightness value"); - let result = Box::new(SPBrightnessGrid(grid)); - NonNull::from(Box::leak(result)) + data: SPByteSlice, +) -> *mut BrightnessGrid { + let data = unsafe { data.as_slice() }; + let grid = match servicepoint::ByteGrid::load(width, height, data) { + None => return std::ptr::null_mut(), + Some(grid) => grid, + }; + if let Ok(grid) = BrightnessGrid::try_from(grid) { + Box::leak(Box::new(grid)) + } else { + std::ptr::null_mut() + } } /// Clones a [SPBrightnessGrid]. @@ -109,10 +108,9 @@ pub unsafe extern "C" fn sp_brightness_grid_load( /// by explicitly calling `sp_brightness_grid_free`. #[no_mangle] pub unsafe extern "C" fn sp_brightness_grid_clone( - brightness_grid: *const SPBrightnessGrid, -) -> NonNull { - assert!(!brightness_grid.is_null()); - let result = Box::new((*brightness_grid).clone()); + brightness_grid: NonNull, +) -> NonNull { + let result = Box::new(unsafe { brightness_grid.as_ref().clone() }); NonNull::from(Box::leak(result)) } @@ -137,10 +135,9 @@ pub unsafe extern "C" fn sp_brightness_grid_clone( /// [SPCommand]: [crate::SPCommand] #[no_mangle] pub unsafe extern "C" fn sp_brightness_grid_free( - brightness_grid: *mut SPBrightnessGrid, + brightness_grid: NonNull, ) { - assert!(!brightness_grid.is_null()); - _ = Box::from_raw(brightness_grid); + _ = unsafe { Box::from_raw(brightness_grid.as_ptr()) }; } /// Gets the current value at the specified position. @@ -165,12 +162,11 @@ pub unsafe extern "C" fn sp_brightness_grid_free( /// - `brightness_grid` is not written to concurrently #[no_mangle] pub unsafe extern "C" fn sp_brightness_grid_get( - brightness_grid: *const SPBrightnessGrid, + brightness_grid: NonNull, x: usize, y: usize, ) -> u8 { - assert!(!brightness_grid.is_null()); - (*brightness_grid).0.get(x, y).into() + unsafe { brightness_grid.as_ref().get(x, y) }.into() } /// Sets the value of the specified position in the [SPBrightnessGrid]. @@ -197,15 +193,14 @@ pub unsafe extern "C" fn sp_brightness_grid_get( /// - `brightness_grid` is not written to or read from concurrently #[no_mangle] pub unsafe extern "C" fn sp_brightness_grid_set( - brightness_grid: *mut SPBrightnessGrid, + brightness_grid: NonNull, x: usize, y: usize, value: u8, ) { - assert!(!brightness_grid.is_null()); let brightness = servicepoint::Brightness::try_from(value) .expect("invalid brightness value"); - (*brightness_grid).0.set(x, y, brightness); + unsafe { (*brightness_grid.as_ptr()).set(x, y, brightness) }; } /// Sets the value of all cells in the [SPBrightnessGrid]. @@ -228,13 +223,12 @@ pub unsafe extern "C" fn sp_brightness_grid_set( /// - `brightness_grid` is not written to or read from concurrently #[no_mangle] pub unsafe extern "C" fn sp_brightness_grid_fill( - brightness_grid: *mut SPBrightnessGrid, + brightness_grid: NonNull, value: u8, ) { - assert!(!brightness_grid.is_null()); let brightness = servicepoint::Brightness::try_from(value) .expect("invalid brightness value"); - (*brightness_grid).0.fill(brightness); + unsafe { (*brightness_grid.as_ptr()).fill(brightness) }; } /// Gets the width of the [SPBrightnessGrid] instance. @@ -256,10 +250,9 @@ pub unsafe extern "C" fn sp_brightness_grid_fill( /// - `brightness_grid` points to a valid [SPBrightnessGrid] #[no_mangle] pub unsafe extern "C" fn sp_brightness_grid_width( - brightness_grid: *const SPBrightnessGrid, + brightness_grid: NonNull, ) -> usize { - assert!(!brightness_grid.is_null()); - (*brightness_grid).0.width() + unsafe { brightness_grid.as_ref().width() } } /// Gets the height of the [SPBrightnessGrid] instance. @@ -281,10 +274,9 @@ pub unsafe extern "C" fn sp_brightness_grid_width( /// - `brightness_grid` points to a valid [SPBrightnessGrid] #[no_mangle] pub unsafe extern "C" fn sp_brightness_grid_height( - brightness_grid: *const SPBrightnessGrid, + brightness_grid: NonNull, ) -> usize { - assert!(!brightness_grid.is_null()); - (*brightness_grid).0.height() + unsafe { brightness_grid.as_ref().height() } } /// Gets an unsafe reference to the data of the [SPBrightnessGrid] instance. @@ -308,15 +300,10 @@ pub unsafe extern "C" fn sp_brightness_grid_height( /// - the returned memory range is never accessed concurrently, either via the [SPBrightnessGrid] or directly #[no_mangle] pub unsafe extern "C" fn sp_brightness_grid_unsafe_data_ref( - brightness_grid: *mut SPBrightnessGrid, + brightness_grid: NonNull, ) -> SPByteSlice { - assert!(!brightness_grid.is_null()); - assert_eq!(core::mem::size_of::(), 1); - let data = (*brightness_grid).0.data_ref_mut(); + assert_eq!(size_of::(), 1); + let data = unsafe { (*brightness_grid.as_ptr()).data_ref_mut() }; // this assumes more about the memory layout than rust guarantees. yikes! - let data: &mut [u8] = transmute(data); - SPByteSlice { - start: NonNull::new(data.as_mut_ptr_range().start).unwrap(), - length: data.len(), - } + unsafe { SPByteSlice::from_slice(transmute(data)) } } diff --git a/src/byte_slice.rs b/src/byte_slice.rs index 678a5d7..066a405 100644 --- a/src/byte_slice.rs +++ b/src/byte_slice.rs @@ -2,7 +2,6 @@ use std::ptr::NonNull; -#[repr(C)] /// Represents a span of memory (`&mut [u8]` ) as a struct usable by C code. /// /// You should not create an instance of this type in your C code. @@ -16,9 +15,29 @@ use std::ptr::NonNull; /// the function returning this type. /// - an instance of this created from C is never passed to a consuming function, as the rust code /// will try to free the memory of a potentially separate allocator. +#[repr(C)] pub struct SPByteSlice { /// The start address of the memory pub start: NonNull, /// The amount of memory in bytes pub length: usize, } + +impl SPByteSlice { + pub(crate) unsafe fn as_slice(&self) -> &[u8] { + unsafe { std::slice::from_raw_parts(self.start.as_ptr(), self.length) } + } + + pub(crate) unsafe fn as_slice_mut(&self) -> &mut [u8] { + unsafe { + std::slice::from_raw_parts_mut(self.start.as_ptr(), self.length) + } + } + + pub(crate) unsafe fn from_slice(slice: &mut [u8]) -> Self { + Self { + start: NonNull::new(slice.as_mut_ptr()).unwrap(), + length: slice.len(), + } + } +} diff --git a/src/char_grid.rs b/src/char_grid.rs index dfaf225..a845f4e 100644 --- a/src/char_grid.rs +++ b/src/char_grid.rs @@ -1,33 +1,27 @@ //! C functions for interacting with [SPCharGrid]s //! //! prefix `sp_char_grid_` +//! +//! A C-wrapper for grid containing UTF-8 characters. +//! +//! As the rust [char] type is not FFI-safe, characters are passed in their UTF-32 form as 32bit unsigned integers. +//! +//! The encoding is enforced in most cases by the rust standard library +//! and will panic when provided with illegal characters. +//! +//! # Examples +//! +//! ```C +//! CharGrid grid = sp_char_grid_new(4, 3); +//! sp_char_grid_fill(grid, '?'); +//! sp_char_grid_set(grid, 0, 0, '!'); +//! sp_char_grid_free(grid); +//! ``` -use servicepoint::Grid; +use crate::SPByteSlice; +use servicepoint::{CharGrid, Grid}; use std::ptr::NonNull; -/// A C-wrapper for grid containing UTF-8 characters. -/// -/// As the rust [char] type is not FFI-safe, characters are passed in their UTF-32 form as 32bit unsigned integers. -/// -/// The encoding is enforced in most cases by the rust standard library -/// and will panic when provided with illegal characters. -/// -/// # Examples -/// -/// ```C -/// CharGrid grid = sp_char_grid_new(4, 3); -/// sp_char_grid_fill(grid, '?'); -/// sp_char_grid_set(grid, 0, 0, '!'); -/// sp_char_grid_free(grid); -/// ``` -pub struct SPCharGrid(pub(crate) servicepoint::CharGrid); - -impl Clone for SPCharGrid { - fn clone(&self) -> Self { - SPCharGrid(self.0.clone()) - } -} - /// Creates a new [SPCharGrid] with the specified dimensions. /// /// returns: [SPCharGrid] initialized to 0. Will never return NULL. @@ -42,9 +36,8 @@ impl Clone for SPCharGrid { pub unsafe extern "C" fn sp_char_grid_new( width: usize, height: usize, -) -> NonNull { - let result = - Box::new(SPCharGrid(servicepoint::CharGrid::new(width, height))); +) -> NonNull { + let result = Box::new(CharGrid::new(width, height)); NonNull::from(Box::leak(result)) } @@ -70,15 +63,12 @@ pub unsafe extern "C" fn sp_char_grid_new( pub unsafe extern "C" fn sp_char_grid_load( width: usize, height: usize, - data: *const u8, - data_length: usize, -) -> NonNull { - assert!(data.is_null()); - let data = std::slice::from_raw_parts(data, data_length); - let result = Box::new(SPCharGrid( - servicepoint::CharGrid::load_utf8(width, height, data.to_vec()) - .unwrap(), - )); + data: SPByteSlice, +) -> NonNull { + let data = unsafe { data.as_slice() }; + // TODO remove unwrap + let result = + Box::new(CharGrid::load_utf8(width, height, data.to_vec()).unwrap()); NonNull::from(Box::leak(result)) } @@ -100,10 +90,9 @@ pub unsafe extern "C" fn sp_char_grid_load( /// by explicitly calling `sp_char_grid_free`. #[no_mangle] pub unsafe extern "C" fn sp_char_grid_clone( - char_grid: *const SPCharGrid, -) -> NonNull { - assert!(!char_grid.is_null()); - let result = Box::new((*char_grid).clone()); + char_grid: NonNull, +) -> NonNull { + let result = Box::new(unsafe { char_grid.as_ref().clone() }); NonNull::from(Box::leak(result)) } @@ -123,9 +112,8 @@ pub unsafe extern "C" fn sp_char_grid_clone( /// /// [SPCommand]: [crate::SPCommand] #[no_mangle] -pub unsafe extern "C" fn sp_char_grid_free(char_grid: *mut SPCharGrid) { - assert!(!char_grid.is_null()); - _ = Box::from_raw(char_grid); +pub unsafe extern "C" fn sp_char_grid_free(char_grid: NonNull) { + _ = unsafe { Box::from_raw(char_grid.as_ptr()) }; } /// Gets the current value at the specified position. @@ -148,12 +136,11 @@ pub unsafe extern "C" fn sp_char_grid_free(char_grid: *mut SPCharGrid) { /// - `char_grid` is not written to concurrently #[no_mangle] pub unsafe extern "C" fn sp_char_grid_get( - char_grid: *const SPCharGrid, + char_grid: NonNull, x: usize, y: usize, ) -> u32 { - assert!(!char_grid.is_null()); - (*char_grid).0.get(x, y) as u32 + unsafe { char_grid.as_ref().get(x, y) as u32 } } /// Sets the value of the specified position in the [SPCharGrid]. @@ -181,13 +168,12 @@ pub unsafe extern "C" fn sp_char_grid_get( /// [SPBitVec]: [crate::SPBitVec] #[no_mangle] pub unsafe extern "C" fn sp_char_grid_set( - char_grid: *mut SPCharGrid, + char_grid: NonNull, x: usize, y: usize, value: u32, ) { - assert!(!char_grid.is_null()); - (*char_grid).0.set(x, y, char::from_u32(value).unwrap()); + unsafe { (*char_grid.as_ptr()).set(x, y, char::from_u32(value).unwrap()) }; } /// Sets the value of all cells in the [SPCharGrid]. @@ -209,11 +195,10 @@ pub unsafe extern "C" fn sp_char_grid_set( /// - `char_grid` is not written to or read from concurrently #[no_mangle] pub unsafe extern "C" fn sp_char_grid_fill( - char_grid: *mut SPCharGrid, + char_grid: NonNull, value: u32, ) { - assert!(!char_grid.is_null()); - (*char_grid).0.fill(char::from_u32(value).unwrap()); + unsafe { (*char_grid.as_ptr()).fill(char::from_u32(value).unwrap()) }; } /// Gets the width of the [SPCharGrid] instance. @@ -233,10 +218,9 @@ pub unsafe extern "C" fn sp_char_grid_fill( /// - `char_grid` points to a valid [SPCharGrid] #[no_mangle] pub unsafe extern "C" fn sp_char_grid_width( - char_grid: *const SPCharGrid, + char_grid: NonNull, ) -> usize { - assert!(!char_grid.is_null()); - (*char_grid).0.width() + unsafe { char_grid.as_ref().width() } } /// Gets the height of the [SPCharGrid] instance. @@ -256,8 +240,7 @@ pub unsafe extern "C" fn sp_char_grid_width( /// - `char_grid` points to a valid [SPCharGrid] #[no_mangle] pub unsafe extern "C" fn sp_char_grid_height( - char_grid: *const SPCharGrid, + char_grid: NonNull, ) -> usize { - assert!(!char_grid.is_null()); - (*char_grid).0.height() + unsafe { char_grid.as_ref().height() } } diff --git a/src/command.rs b/src/command.rs index f7e50ea..eccac1b 100644 --- a/src/command.rs +++ b/src/command.rs @@ -2,12 +2,12 @@ //! //! prefix `sp_command_` -use std::ptr::{null_mut, NonNull}; - -use crate::{ - SPBitVec, SPBitmap, SPBrightnessGrid, SPCharGrid, SPCompressionCode, - SPCp437Grid, SPPacket, +use crate::SPBitVec; +use servicepoint::{ + BinaryOperation, Bitmap, BrightnessGrid, CharGrid, CompressionCode, + Cp437Grid, GlobalBrightnessCommand, Packet, TypedCommand, }; +use std::ptr::NonNull; /// A low-level display command. /// @@ -23,13 +23,6 @@ use crate::{ /// ``` /// /// [SPConnection]: [crate::SPConnection] -pub struct SPCommand(pub(crate) servicepoint::Command); - -impl Clone for SPCommand { - fn clone(&self) -> Self { - SPCommand(self.0.clone()) - } -} /// Tries to turn a [SPPacket] into a [SPCommand]. /// @@ -52,12 +45,12 @@ impl Clone for SPCommand { /// by explicitly calling `sp_command_free`. #[no_mangle] pub unsafe extern "C" fn sp_command_try_from_packet( - packet: *mut SPPacket, -) -> *mut SPCommand { - let packet = *Box::from_raw(packet); - match servicepoint::Command::try_from(packet.0) { - Err(_) => null_mut(), - Ok(command) => Box::into_raw(Box::new(SPCommand(command))), + packet: NonNull, +) -> *mut TypedCommand { + let packet = *unsafe { Box::from_raw(packet.as_ptr()) }; + match servicepoint::TypedCommand::try_from(packet) { + Err(_) => std::ptr::null_mut(), + Ok(command) => Box::into_raw(Box::new(command)), } } @@ -79,10 +72,9 @@ pub unsafe extern "C" fn sp_command_try_from_packet( /// by explicitly calling `sp_command_free`. #[no_mangle] pub unsafe extern "C" fn sp_command_clone( - command: *const SPCommand, -) -> NonNull { - assert!(!command.is_null()); - let result = Box::new((*command).clone()); + command: NonNull, +) -> NonNull { + let result = Box::new(unsafe { command.as_ref().clone() }); NonNull::from(Box::leak(result)) } @@ -105,8 +97,8 @@ pub unsafe extern "C" fn sp_command_clone( /// - the returned [SPCommand] instance is freed in some way, either by using a consuming function or /// by explicitly calling `sp_command_free`. #[no_mangle] -pub unsafe extern "C" fn sp_command_clear() -> NonNull { - let result = Box::new(SPCommand(servicepoint::Command::Clear)); +pub unsafe extern "C" fn sp_command_clear() -> NonNull { + let result = Box::new(servicepoint::ClearCommand.into()); NonNull::from(Box::leak(result)) } @@ -123,8 +115,8 @@ pub unsafe extern "C" fn sp_command_clear() -> NonNull { /// - the returned [SPCommand] instance is freed in some way, either by using a consuming function or /// by explicitly calling `sp_command_free`. #[no_mangle] -pub unsafe extern "C" fn sp_command_hard_reset() -> NonNull { - let result = Box::new(SPCommand(servicepoint::Command::HardReset)); +pub unsafe extern "C" fn sp_command_hard_reset() -> NonNull { + let result = Box::new(servicepoint::HardResetCommand.into()); NonNull::from(Box::leak(result)) } @@ -139,8 +131,8 @@ pub unsafe extern "C" fn sp_command_hard_reset() -> NonNull { /// - the returned [SPCommand] instance is freed in some way, either by using a consuming function or /// by explicitly calling `sp_command_free`. #[no_mangle] -pub unsafe extern "C" fn sp_command_fade_out() -> NonNull { - let result = Box::new(SPCommand(servicepoint::Command::FadeOut)); +pub unsafe extern "C" fn sp_command_fade_out() -> NonNull { + let result = Box::new(servicepoint::FadeOutCommand.into()); NonNull::from(Box::leak(result)) } @@ -161,11 +153,10 @@ pub unsafe extern "C" fn sp_command_fade_out() -> NonNull { #[no_mangle] pub unsafe extern "C" fn sp_command_brightness( brightness: u8, -) -> NonNull { +) -> NonNull { let brightness = servicepoint::Brightness::try_from(brightness) .expect("invalid brightness"); - let result = - Box::new(SPCommand(servicepoint::Command::Brightness(brightness))); + let result = Box::new(GlobalBrightnessCommand::from(brightness).into()); NonNull::from(Box::leak(result)) } @@ -191,14 +182,16 @@ pub unsafe extern "C" fn sp_command_brightness( pub unsafe extern "C" fn sp_command_char_brightness( x: usize, y: usize, - grid: *mut SPBrightnessGrid, -) -> NonNull { - assert!(!grid.is_null()); - let byte_grid = *Box::from_raw(grid); - let result = Box::new(SPCommand(servicepoint::Command::CharBrightness( - servicepoint::Origin::new(x, y), - byte_grid.0, - ))); + grid: NonNull, +) -> NonNull { + let grid = unsafe { *Box::from_raw(grid.as_ptr()) }; + let result = Box::new( + servicepoint::BrightnessGridCommand { + origin: servicepoint::Origin::new(x, y), + grid, + } + .into(), + ); NonNull::from(Box::leak(result)) } @@ -230,17 +223,17 @@ pub unsafe extern "C" fn sp_command_char_brightness( #[no_mangle] pub unsafe extern "C" fn sp_command_bitmap_linear( offset: usize, - bit_vec: *mut SPBitVec, - compression: SPCompressionCode, -) -> NonNull { - assert!(!bit_vec.is_null()); - let bit_vec = *Box::from_raw(bit_vec); - let result = Box::new(SPCommand(servicepoint::Command::BitmapLinear( - offset, - bit_vec.into(), - compression.try_into().expect("invalid compression code"), - ))); - NonNull::from(Box::leak(result)) + bit_vec: NonNull, + compression: CompressionCode, +) -> *mut TypedCommand { + unsafe { + sp_command_bitmap_linear_internal( + offset, + bit_vec, + compression, + BinaryOperation::Overwrite, + ) + } } /// Set pixel data according to an and-mask starting at the offset. @@ -271,17 +264,17 @@ pub unsafe extern "C" fn sp_command_bitmap_linear( #[no_mangle] pub unsafe extern "C" fn sp_command_bitmap_linear_and( offset: usize, - bit_vec: *mut SPBitVec, - compression: SPCompressionCode, -) -> NonNull { - assert!(!bit_vec.is_null()); - let bit_vec = *Box::from_raw(bit_vec); - let result = Box::new(SPCommand(servicepoint::Command::BitmapLinearAnd( - offset, - bit_vec.into(), - compression.try_into().expect("invalid compression code"), - ))); - NonNull::from(Box::leak(result)) + bit_vec: NonNull, + compression: CompressionCode, +) -> *mut TypedCommand { + unsafe { + sp_command_bitmap_linear_internal( + offset, + bit_vec, + compression, + BinaryOperation::Xor, + ) + } } /// Set pixel data according to an or-mask starting at the offset. @@ -312,17 +305,17 @@ pub unsafe extern "C" fn sp_command_bitmap_linear_and( #[no_mangle] pub unsafe extern "C" fn sp_command_bitmap_linear_or( offset: usize, - bit_vec: *mut SPBitVec, - compression: SPCompressionCode, -) -> NonNull { - assert!(!bit_vec.is_null()); - let bit_vec = *Box::from_raw(bit_vec); - let result = Box::new(SPCommand(servicepoint::Command::BitmapLinearOr( - offset, - bit_vec.into(), - compression.try_into().expect("invalid compression code"), - ))); - NonNull::from(Box::leak(result)) + bit_vec: NonNull, + compression: CompressionCode, +) -> *mut TypedCommand { + unsafe { + sp_command_bitmap_linear_internal( + offset, + bit_vec, + compression, + BinaryOperation::Or, + ) + } } /// Set pixel data according to a xor-mask starting at the offset. @@ -353,17 +346,39 @@ pub unsafe extern "C" fn sp_command_bitmap_linear_or( #[no_mangle] pub unsafe extern "C" fn sp_command_bitmap_linear_xor( offset: usize, - bit_vec: *mut SPBitVec, - compression: SPCompressionCode, -) -> NonNull { - assert!(!bit_vec.is_null()); - let bit_vec = *Box::from_raw(bit_vec); - let result = Box::new(SPCommand(servicepoint::Command::BitmapLinearXor( + bit_vec: NonNull, + compression: CompressionCode, +) -> *mut TypedCommand { + unsafe { + sp_command_bitmap_linear_internal( + offset, + bit_vec, + compression, + BinaryOperation::Xor, + ) + } +} + +#[inline] +unsafe fn sp_command_bitmap_linear_internal( + offset: usize, + bit_vec: NonNull, + compression: CompressionCode, + operation: BinaryOperation, +) -> *mut TypedCommand { + let bit_vec = unsafe { *Box::from_raw(bit_vec.as_ptr()) }; + let compression = match compression.try_into() { + Ok(compression) => compression, + Err(_) => return std::ptr::null_mut(), + }; + let command = servicepoint::BitVecCommand { offset, - bit_vec.into(), - compression.try_into().expect("invalid compression code"), - ))); - NonNull::from(Box::leak(result)) + operation, + bitvec: bit_vec.0, + compression, + } + .into(); + Box::leak(Box::new(command)) } /// Show codepage 437 encoded text on the screen. @@ -388,14 +403,16 @@ pub unsafe extern "C" fn sp_command_bitmap_linear_xor( pub unsafe extern "C" fn sp_command_cp437_data( x: usize, y: usize, - grid: *mut SPCp437Grid, -) -> NonNull { - assert!(!grid.is_null()); - let grid = *Box::from_raw(grid); - let result = Box::new(SPCommand(servicepoint::Command::Cp437Data( - servicepoint::Origin::new(x, y), - grid.0, - ))); + grid: NonNull, +) -> NonNull { + let grid = *unsafe { Box::from_raw(grid.as_ptr()) }; + let result = Box::new( + servicepoint::Cp437GridCommand { + origin: servicepoint::Origin::new(x, y), + grid, + } + .into(), + ); NonNull::from(Box::leak(result)) } @@ -421,14 +438,16 @@ pub unsafe extern "C" fn sp_command_cp437_data( pub unsafe extern "C" fn sp_command_utf8_data( x: usize, y: usize, - grid: *mut SPCharGrid, -) -> NonNull { - assert!(!grid.is_null()); - let grid = *Box::from_raw(grid); - let result = Box::new(SPCommand(servicepoint::Command::Utf8Data( - servicepoint::Origin::new(x, y), - grid.0, - ))); + grid: NonNull, +) -> NonNull { + let grid = unsafe { *Box::from_raw(grid.as_ptr()) }; + let result = Box::new( + servicepoint::CharGridCommand { + origin: servicepoint::Origin::new(x, y), + grid, + } + .into(), + ); NonNull::from(Box::leak(result)) } @@ -456,19 +475,21 @@ pub unsafe extern "C" fn sp_command_utf8_data( pub unsafe extern "C" fn sp_command_bitmap_linear_win( x: usize, y: usize, - bitmap: *mut SPBitmap, - compression_code: SPCompressionCode, -) -> NonNull { - assert!(!bitmap.is_null()); - let byte_grid = (*Box::from_raw(bitmap)).0; - let result = Box::new(SPCommand(servicepoint::Command::BitmapLinearWin( - servicepoint::Origin::new(x, y), - byte_grid, - compression_code - .try_into() - .expect("invalid compression code"), - ))); - NonNull::from(Box::leak(result)) + bitmap: NonNull, + compression: CompressionCode, +) -> *mut TypedCommand { + let bitmap = unsafe { *Box::from_raw(bitmap.as_ptr()) }; + let compression = match compression.try_into() { + Ok(compression) => compression, + Err(_) => return std::ptr::null_mut(), + }; + let command = servicepoint::BitmapCommand { + origin: servicepoint::Origin::new(x, y), + bitmap, + compression, + } + .into(); + Box::leak(Box::new(command)) } /// Deallocates a [SPCommand]. @@ -492,7 +513,6 @@ pub unsafe extern "C" fn sp_command_bitmap_linear_win( /// - `command` is not used concurrently or after this call /// - `command` was not passed to another consuming function, e.g. to create a [SPPacket] #[no_mangle] -pub unsafe extern "C" fn sp_command_free(command: *mut SPCommand) { - assert!(!command.is_null()); - _ = Box::from_raw(command); +pub unsafe extern "C" fn sp_command_free(command: NonNull) { + _ = unsafe { Box::from_raw(command.as_ptr()) }; } diff --git a/src/connection.rs b/src/connection.rs index 8b31243..1705538 100644 --- a/src/connection.rs +++ b/src/connection.rs @@ -1,22 +1,20 @@ //! C functions for interacting with [SPConnection]s //! //! prefix `sp_connection_` +//! +//! A connection to the display. +//! +//! # Examples +//! +//! ```C +//! CConnection connection = sp_connection_open("172.23.42.29:2342"); +//! if (connection != NULL) +//! sp_connection_send_command(connection, sp_command_clear()); +//! ``` +use servicepoint::{Connection, Packet, TypedCommand, UdpConnection}; use std::ffi::{c_char, CStr}; -use std::ptr::{null_mut, NonNull}; - -use crate::{SPCommand, SPPacket}; - -/// A connection to the display. -/// -/// # Examples -/// -/// ```C -/// CConnection connection = sp_connection_open("172.23.42.29:2342"); -/// if (connection != NULL) -/// sp_connection_send_command(connection, sp_command_clear()); -/// ``` -pub struct SPConnection(pub(crate) servicepoint::Connection); +use std::ptr::NonNull; /// Creates a new instance of [SPConnection]. /// @@ -34,33 +32,46 @@ pub struct SPConnection(pub(crate) servicepoint::Connection); /// by explicitly calling `sp_connection_free`. #[no_mangle] pub unsafe extern "C" fn sp_connection_open( - host: *const c_char, -) -> *mut SPConnection { - assert!(!host.is_null()); - let host = CStr::from_ptr(host).to_str().expect("Bad encoding"); - let connection = match servicepoint::Connection::open(host) { - Err(_) => return null_mut(), + host: NonNull, +) -> *mut UdpConnection { + let host = unsafe { CStr::from_ptr(host.as_ptr()) } + .to_str() + .expect("Bad encoding"); + let connection = match UdpConnection::open(host) { + Err(_) => return std::ptr::null_mut(), Ok(value) => value, }; - Box::into_raw(Box::new(SPConnection(connection))) + Box::into_raw(Box::new(connection)) } -/// Creates a new instance of [SPConnection] for testing that does not actually send anything. -/// -/// returns: a new instance. Will never return NULL. -/// -/// # Safety -/// -/// The caller has to make sure that: -/// -/// - the returned instance is freed in some way, either by using a consuming function or -/// by explicitly calling `sp_connection_free`. -#[no_mangle] -pub unsafe extern "C" fn sp_connection_fake() -> NonNull { - let result = Box::new(SPConnection(servicepoint::Connection::Fake)); - NonNull::from(Box::leak(result)) -} +//#[no_mangle] +//pub unsafe extern "C" fn sp_connection_open_ipv4( +// host: SocketAddrV4, +//) -> *mut SPConnection { +// let connection = match servicepoint::UdpConnection::open(host) { +// Err(_) => return std::ptr::null_mut(), +// Ok(value) => value, +// }; +// +// Box::into_raw(Box::new(SPConnection(connection))) +//} + +// /// Creates a new instance of [SPUdpConnection] for testing that does not actually send anything. +// /// +// /// returns: a new instance. Will never return NULL. +// /// +// /// # Safety +// /// +// /// The caller has to make sure that: +// /// +// /// - the returned instance is freed in some way, either by using a consuming function or +// /// by explicitly calling `sp_connection_free`. +// #[no_mangle] +// pub unsafe extern "C" fn sp_connection_fake() -> NonNull { +// let result = Box::new(SPUdpConnection(servicepoint::Connection::Fake)); +// NonNull::from(Box::leak(result)) +// } /// Sends a [SPPacket] to the display using the [SPConnection]. /// @@ -82,13 +93,11 @@ pub unsafe extern "C" fn sp_connection_fake() -> NonNull { /// - `packet` is not used concurrently or after this call #[no_mangle] pub unsafe extern "C" fn sp_connection_send_packet( - connection: *const SPConnection, - packet: *mut SPPacket, + connection: NonNull, + packet: NonNull, ) -> bool { - assert!(!connection.is_null()); - assert!(!packet.is_null()); - let packet = Box::from_raw(packet); - (*connection).0.send((*packet).0).is_ok() + let packet = unsafe { Box::from_raw(packet.as_ptr()) }; + unsafe { connection.as_ref().send(*packet) }.is_ok() } /// Sends a [SPCommand] to the display using the [SPConnection]. @@ -111,13 +120,11 @@ pub unsafe extern "C" fn sp_connection_send_packet( /// - `command` is not used concurrently or after this call #[no_mangle] pub unsafe extern "C" fn sp_connection_send_command( - connection: *const SPConnection, - command: *mut SPCommand, + connection: NonNull, + command: NonNull, ) -> bool { - assert!(!connection.is_null()); - assert!(!command.is_null()); - let command = (*Box::from_raw(command)).0; - (*connection).0.send(command).is_ok() + let command = *unsafe { Box::from_raw(command.as_ptr()) }; + unsafe { connection.as_ref().send(command) }.is_ok() } /// Closes and deallocates a [SPConnection]. @@ -133,7 +140,8 @@ pub unsafe extern "C" fn sp_connection_send_command( /// - `connection` points to a valid [SPConnection] /// - `connection` is not used concurrently or after this call #[no_mangle] -pub unsafe extern "C" fn sp_connection_free(connection: *mut SPConnection) { - assert!(!connection.is_null()); - _ = Box::from_raw(connection); +pub unsafe extern "C" fn sp_connection_free( + connection: NonNull, +) { + _ = unsafe { Box::from_raw(connection.as_ptr()) }; } diff --git a/src/constants.rs b/src/constants.rs deleted file mode 100644 index 1a268f4..0000000 --- a/src/constants.rs +++ /dev/null @@ -1,48 +0,0 @@ -//! re-exported constants for use in C - -use servicepoint::CompressionCode; -use std::time::Duration; - -/// size of a single tile in one dimension -pub const SP_TILE_SIZE: usize = 8; - -/// Display tile count in the x-direction -pub const SP_TILE_WIDTH: usize = 56; - -/// Display tile count in the y-direction -pub const SP_TILE_HEIGHT: usize = 20; - -/// Display width in pixels -pub const SP_PIXEL_WIDTH: usize = SP_TILE_WIDTH * SP_TILE_SIZE; - -/// Display height in pixels -pub const SP_PIXEL_HEIGHT: usize = SP_TILE_HEIGHT * SP_TILE_SIZE; - -/// pixel count on whole screen -pub const SP_PIXEL_COUNT: usize = SP_PIXEL_WIDTH * SP_PIXEL_HEIGHT; - -/// Actual hardware limit is around 28-29ms/frame. Rounded up for less dropped packets. -pub const SP_FRAME_PACING_MS: u128 = Duration::from_millis(30).as_millis(); - -/// Specifies the kind of compression to use. -#[repr(u16)] -pub enum SPCompressionCode { - /// no compression - Uncompressed = 0x0, - /// compress using flate2 with zlib header - Zlib = 0x677a, - /// compress using bzip2 - Bzip2 = 0x627a, - /// compress using lzma - Lzma = 0x6c7a, - /// compress using Zstandard - Zstd = 0x7a73, -} - -impl TryFrom for CompressionCode { - type Error = (); - - fn try_from(value: SPCompressionCode) -> Result { - CompressionCode::try_from(value as u16) - } -} diff --git a/src/cp437_grid.rs b/src/cp437_grid.rs index 9b366c8..e635247 100644 --- a/src/cp437_grid.rs +++ b/src/cp437_grid.rs @@ -1,31 +1,25 @@ //! C functions for interacting with [SPCp437Grid]s //! //! prefix `sp_cp437_grid_` +//! +//! +//! A C-wrapper for grid containing codepage 437 characters. +//! +//! The encoding is currently not enforced. +//! +//! # Examples +//! +//! ```C +//! Cp437Grid grid = sp_cp437_grid_new(4, 3); +//! sp_cp437_grid_fill(grid, '?'); +//! sp_cp437_grid_set(grid, 0, 0, '!'); +//! sp_cp437_grid_free(grid); +//! ``` use crate::SPByteSlice; -use servicepoint::{DataRef, Grid}; +use servicepoint::{Cp437Grid, DataRef, Grid}; use std::ptr::NonNull; -/// A C-wrapper for grid containing codepage 437 characters. -/// -/// The encoding is currently not enforced. -/// -/// # Examples -/// -/// ```C -/// Cp437Grid grid = sp_cp437_grid_new(4, 3); -/// sp_cp437_grid_fill(grid, '?'); -/// sp_cp437_grid_set(grid, 0, 0, '!'); -/// sp_cp437_grid_free(grid); -/// ``` -pub struct SPCp437Grid(pub(crate) servicepoint::Cp437Grid); - -impl Clone for SPCp437Grid { - fn clone(&self) -> Self { - SPCp437Grid(self.0.clone()) - } -} - /// Creates a new [SPCp437Grid] with the specified dimensions. /// /// returns: [SPCp437Grid] initialized to 0. Will never return NULL. @@ -40,9 +34,8 @@ impl Clone for SPCp437Grid { pub unsafe extern "C" fn sp_cp437_grid_new( width: usize, height: usize, -) -> NonNull { - let result = - Box::new(SPCp437Grid(servicepoint::Cp437Grid::new(width, height))); +) -> NonNull { + let result = Box::new(Cp437Grid::new(width, height)); NonNull::from(Box::leak(result)) } @@ -67,15 +60,15 @@ pub unsafe extern "C" fn sp_cp437_grid_new( pub unsafe extern "C" fn sp_cp437_grid_load( width: usize, height: usize, - data: *const u8, - data_length: usize, -) -> NonNull { - assert!(data.is_null()); - let data = std::slice::from_raw_parts(data, data_length); - let result = Box::new(SPCp437Grid(servicepoint::Cp437Grid::load( - width, height, data, - ))); - NonNull::from(Box::leak(result)) + data: SPByteSlice, +) -> *mut Cp437Grid { + let data = unsafe { data.as_slice() }; + let grid = Cp437Grid::load(width, height, data); + if let Some(grid) = grid { + Box::leak(Box::new(grid)) + } else { + std::ptr::null_mut() + } } /// Clones a [SPCp437Grid]. @@ -96,10 +89,9 @@ pub unsafe extern "C" fn sp_cp437_grid_load( /// by explicitly calling `sp_cp437_grid_free`. #[no_mangle] pub unsafe extern "C" fn sp_cp437_grid_clone( - cp437_grid: *const SPCp437Grid, -) -> NonNull { - assert!(!cp437_grid.is_null()); - let result = Box::new((*cp437_grid).clone()); + cp437_grid: NonNull, +) -> NonNull { + let result = Box::new(unsafe { cp437_grid.as_ref().clone() }); NonNull::from(Box::leak(result)) } @@ -119,9 +111,8 @@ pub unsafe extern "C" fn sp_cp437_grid_clone( /// /// [SPCommand]: [crate::SPCommand] #[no_mangle] -pub unsafe extern "C" fn sp_cp437_grid_free(cp437_grid: *mut SPCp437Grid) { - assert!(!cp437_grid.is_null()); - _ = Box::from_raw(cp437_grid); +pub unsafe extern "C" fn sp_cp437_grid_free(cp437_grid: NonNull) { + _ = unsafe { Box::from_raw(cp437_grid.as_ptr()) }; } /// Gets the current value at the specified position. @@ -144,12 +135,11 @@ pub unsafe extern "C" fn sp_cp437_grid_free(cp437_grid: *mut SPCp437Grid) { /// - `cp437_grid` is not written to concurrently #[no_mangle] pub unsafe extern "C" fn sp_cp437_grid_get( - cp437_grid: *const SPCp437Grid, + cp437_grid: NonNull, x: usize, y: usize, ) -> u8 { - assert!(!cp437_grid.is_null()); - (*cp437_grid).0.get(x, y) + unsafe { cp437_grid.as_ref().get(x, y) } } /// Sets the value of the specified position in the [SPCp437Grid]. @@ -177,13 +167,12 @@ pub unsafe extern "C" fn sp_cp437_grid_get( /// [SPBitVec]: [crate::SPBitVec] #[no_mangle] pub unsafe extern "C" fn sp_cp437_grid_set( - cp437_grid: *mut SPCp437Grid, + cp437_grid: NonNull, x: usize, y: usize, value: u8, ) { - assert!(!cp437_grid.is_null()); - (*cp437_grid).0.set(x, y, value); + unsafe { (*cp437_grid.as_ptr()).set(x, y, value) }; } /// Sets the value of all cells in the [SPCp437Grid]. @@ -205,11 +194,10 @@ pub unsafe extern "C" fn sp_cp437_grid_set( /// - `cp437_grid` is not written to or read from concurrently #[no_mangle] pub unsafe extern "C" fn sp_cp437_grid_fill( - cp437_grid: *mut SPCp437Grid, + cp437_grid: NonNull, value: u8, ) { - assert!(!cp437_grid.is_null()); - (*cp437_grid).0.fill(value); + unsafe { (*cp437_grid.as_ptr()).fill(value) }; } /// Gets the width of the [SPCp437Grid] instance. @@ -229,10 +217,9 @@ pub unsafe extern "C" fn sp_cp437_grid_fill( /// - `cp437_grid` points to a valid [SPCp437Grid] #[no_mangle] pub unsafe extern "C" fn sp_cp437_grid_width( - cp437_grid: *const SPCp437Grid, + cp437_grid: NonNull, ) -> usize { - assert!(!cp437_grid.is_null()); - (*cp437_grid).0.width() + unsafe { cp437_grid.as_ref().width() } } /// Gets the height of the [SPCp437Grid] instance. @@ -252,10 +239,9 @@ pub unsafe extern "C" fn sp_cp437_grid_width( /// - `cp437_grid` points to a valid [SPCp437Grid] #[no_mangle] pub unsafe extern "C" fn sp_cp437_grid_height( - cp437_grid: *const SPCp437Grid, + cp437_grid: NonNull, ) -> usize { - assert!(!cp437_grid.is_null()); - (*cp437_grid).0.height() + unsafe { cp437_grid.as_ref().height() } } /// Gets an unsafe reference to the data of the [SPCp437Grid] instance. @@ -275,11 +261,7 @@ pub unsafe extern "C" fn sp_cp437_grid_height( /// - the returned memory range is never accessed concurrently, either via the [SPCp437Grid] or directly #[no_mangle] pub unsafe extern "C" fn sp_cp437_grid_unsafe_data_ref( - cp437_grid: *mut SPCp437Grid, + cp437_grid: NonNull, ) -> SPByteSlice { - let data = (*cp437_grid).0.data_ref_mut(); - SPByteSlice { - start: NonNull::new(data.as_mut_ptr_range().start).unwrap(), - length: data.len(), - } + unsafe { SPByteSlice::from_slice((*cp437_grid.as_ptr()).data_ref_mut()) } } diff --git a/src/lib.rs b/src/lib.rs index 887fb40..831daea 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -32,7 +32,6 @@ pub use crate::byte_slice::*; pub use crate::char_grid::*; pub use crate::command::*; pub use crate::connection::*; -pub use crate::constants::*; pub use crate::cp437_grid::*; pub use crate::packet::*; @@ -43,6 +42,10 @@ mod byte_slice; mod char_grid; mod command; mod connection; -mod constants; mod cp437_grid; mod packet; + +use std::time::Duration; + +/// Actual hardware limit is around 28-29ms/frame. Rounded up for less dropped packets. +pub const SP_FRAME_PACING_MS: u128 = Duration::from_millis(30).as_millis(); diff --git a/src/packet.rs b/src/packet.rs index 9293a8a..f8235ab 100644 --- a/src/packet.rs +++ b/src/packet.rs @@ -1,13 +1,13 @@ //! C functions for interacting with [SPPacket]s //! //! prefix `sp_packet_` +//! +//! +//! The raw packet -use std::ptr::{null_mut, NonNull}; - -use crate::SPCommand; - -/// The raw packet -pub struct SPPacket(pub(crate) servicepoint::Packet); +use crate::SPByteSlice; +use servicepoint::{Header, Packet, TypedCommand}; +use std::ptr::NonNull; /// Turns a [SPCommand] into a [SPPacket]. /// The [SPCommand] gets consumed. @@ -28,12 +28,14 @@ pub struct SPPacket(pub(crate) servicepoint::Packet); /// by explicitly calling `sp_packet_free`. #[no_mangle] pub unsafe extern "C" fn sp_packet_from_command( - command: *mut SPCommand, -) -> NonNull { - assert!(!command.is_null()); - let command = *Box::from_raw(command); - let result = Box::new(SPPacket(command.0.into())); - NonNull::from(Box::leak(result)) + command: NonNull, +) -> *mut Packet { + let command = unsafe { *Box::from_raw(command.as_ptr()) }; + if let Ok(packet) = command.try_into() { + Box::leak(Box::new(packet)) + } else { + std::ptr::null_mut() + } } /// Tries to load a [SPPacket] from the passed array with the specified length. @@ -53,15 +55,11 @@ pub unsafe extern "C" fn sp_packet_from_command( /// - the returned [SPPacket] instance is freed in some way, either by using a consuming function or /// by explicitly calling `sp_packet_free`. #[no_mangle] -pub unsafe extern "C" fn sp_packet_try_load( - data: *const u8, - length: usize, -) -> *mut SPPacket { - assert!(!data.is_null()); - let data = std::slice::from_raw_parts(data, length); +pub unsafe extern "C" fn sp_packet_try_load(data: SPByteSlice) -> *mut Packet { + let data = unsafe { data.as_slice() }; match servicepoint::Packet::try_from(data) { - Err(_) => null_mut(), - Ok(packet) => Box::into_raw(Box::new(SPPacket(packet))), + Err(_) => std::ptr::null_mut(), + Ok(packet) => Box::into_raw(Box::new(packet)), } } @@ -91,35 +89,50 @@ pub unsafe extern "C" fn sp_packet_try_load( /// by explicitly calling [sp_packet_free]. #[no_mangle] pub unsafe extern "C" fn sp_packet_from_parts( - command_code: u16, - a: u16, - b: u16, - c: u16, - d: u16, - payload: *const u8, - payload_len: usize, -) -> NonNull { - assert_eq!(payload.is_null(), payload_len == 0); - + header: Header, + payload: *const SPByteSlice, +) -> NonNull { let payload = if payload.is_null() { vec![] } else { - let payload = std::slice::from_raw_parts(payload, payload_len); + let payload = unsafe { (*payload).as_slice() }; Vec::from(payload) }; - let packet = servicepoint::Packet { - header: servicepoint::Header { - command_code, - a, - b, - c, - d, - }, - payload, - }; - let result = Box::new(SPPacket(packet)); - NonNull::from(Box::leak(result)) + let packet = Box::new(Packet { header, payload }); + NonNull::from(Box::leak(packet)) +} + +#[no_mangle] +pub unsafe extern "C" fn sp_packet_get_header( + packet: NonNull, +) -> NonNull
{ + NonNull::from(&mut unsafe { (*packet.as_ptr()).header }) +} + +#[no_mangle] +pub unsafe extern "C" fn sp_packet_get_payload( + packet: NonNull, +) -> SPByteSlice { + unsafe { SPByteSlice::from_slice(&mut *(*packet.as_ptr()).payload) } +} + +#[no_mangle] +pub unsafe extern "C" fn sp_packet_set_payload( + packet: NonNull, + data: SPByteSlice, +) { + unsafe { (*packet.as_ptr()).payload = data.as_slice().to_vec() } +} + +#[no_mangle] +pub unsafe extern "C" fn sp_packet_write_to( + packet: NonNull, + buffer: SPByteSlice, +) { + unsafe { + packet.as_ref().serialize_to(buffer.as_slice_mut()); + } } /// Clones a [SPPacket]. @@ -140,10 +153,9 @@ pub unsafe extern "C" fn sp_packet_from_parts( /// by explicitly calling `sp_packet_free`. #[no_mangle] pub unsafe extern "C" fn sp_packet_clone( - packet: *const SPPacket, -) -> NonNull { - assert!(!packet.is_null()); - let result = Box::new(SPPacket((*packet).0.clone())); + packet: NonNull, +) -> NonNull { + let result = Box::new(unsafe { packet.as_ref().clone() }); NonNull::from(Box::leak(result)) } @@ -160,7 +172,6 @@ pub unsafe extern "C" fn sp_packet_clone( /// - `packet` points to a valid [SPPacket] /// - `packet` is not used concurrently or after this call #[no_mangle] -pub unsafe extern "C" fn sp_packet_free(packet: *mut SPPacket) { - assert!(!packet.is_null()); - _ = Box::from_raw(packet) +pub unsafe extern "C" fn sp_packet_free(packet: NonNull) { + _ = unsafe { Box::from_raw(packet.as_ptr()) } }