wrap the C++ library in a -sys crate to ensure compatibility (#24)

This PR transforms the repo into a two crate workspace, one crate being a -sys wrapper crate around the c++ library, and the other being the higher level rust API you use.

Author: TDHolmes

.github/workflows/rust.yml

@@ -16,13 +16,13 @@ jobs:
     steps:
     - uses: actions/checkout@v2
     - name: Build - All Features
-      run: cargo build --verbose --all-features
+      run: RUSTFLAGS="-D warnings" cargo build --verbose --all-features
     - name: Build - Default
-      run: cargo build --verbose
+      run: RUSTFLAGS="-D warnings" cargo build --verbose --features="c-stubs"
     - name: Build - No Default Features
-      run: cargo build --verbose --no-default-features
+      run: RUSTFLAGS="-D warnings" cargo build --verbose --no-default-features --features="c-stubs"
     - name: Build - Check Examples & Tests
-      run: cargo check --verbose --all-features --tests --examples
+      run: RUSTFLAGS="-D warnings" cargo check --verbose --all-features --tests --examples
 
   clippy:
     runs-on: ubuntu-latest
@@ -48,4 +48,4 @@ jobs:
             toolchain: nightly
             components: rustfmt
             override: true
-      - run: rustfmt --check --edition 2018 ./src/* ./examples/*
+      - run: rustfmt --check --edition 2018 ./*/src/* ./*/examples/* ./*/build.rs

.gitignore

@@ -9,3 +9,6 @@ Cargo.lock
 
 # These are backup files generated by rustfmt
 **/*.rs.bk
+
+# mac stuff
+*.DS_Store

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "rpi-led-matrix-sys/cpp-library"]
+	path = rpi-led-matrix-sys/cpp-library
+	url = [email protected]:hzeller/rpi-rgb-led-matrix.git

.vscode/settings.json

@@ -1,47 +1,9 @@
-[package]
-name = "rpi-led-matrix"
-description = "Bindings for Hzeller's RPi-RGB-Led-Matrix"
-version = "0.2.2"
-authors = [
-    "Vincent Pasquier <[email protected]>",
-    "Tyler Holmes <[email protected]>",
-    "Broderick Carlin <[email protected]>",
-]
-repository = "https://github.com/rust-rpi-led-matrix/rust-rpi-rgb-led-matrix"
-homepage = "https://docs.rs/rpi-led-matrix/"
-build = "build.rs"
-license = "GPL-3.0"
-readme = "README.md"
-edition = "2018"
-
-[features]
-default = ["embeddedgraphics"]
-
-embeddedgraphics = ["embedded-graphics"]
-args = ["clap"]
-
-[build-dependencies]
-gcc = "0.3"
-
-[dependencies]
-libc = "0.2"
-embedded-graphics = { version = "0.6.2", optional = true }
-clap = { version = "2.33", optional = true }
+[workspace]
 
-[[example]]
-name = "arguments"
-required-features = ["args"]
-
-[[example]]
-name = "c-api-basic"
-required-features = ["args"]
-
-[[example]]
-name = "embedded-graphics-basic"
-required-features = ["args", "embeddedgraphics"]
-
-[package.metadata.docs.rs]
-all-features = true
+members = [
+    "rpi-led-matrix",
+    "rpi-led-matrix-sys",
+]
 
 [profile.release]
 codegen-units = 1

Cargo.toml

@@ -1,10 +1,10 @@
 # Control RGB LED displays from Rust
 
-This repository contains rust bindings for the C++ library [rpi-rgb-led-matrix](https://github.com/hzeller/rpi-rgb-led-matrix),
-which enables controlling Hub75 based displays.
-In order to take advantage of the newer APIs, the minimum supported commit of the library is
-[55fa32f](https://github.com/hzeller/rpi-rgb-led-matrix/commit/55fa32fc2e02afb254ac834aea93589d5b891a11)
-(Sept. 7th, 2020), which exposes all parameters that affect how the matrix runs.
+This repository contains rust bindings for the C++ library
+[rpi-rgb-led-matrix](https://github.com/hzeller/rpi-rgb-led-matrix),
+which enables controlling Hub75 based displays. It includes both raw bindings
+to the library in [`rpi-led-matrix-sys`] as well as higher level, safe rust
+bindings in [`rpi-led-matrix`].
 
 # Usage
 
@@ -24,3 +24,6 @@ for red in 0..255 {
 }
 ```
 Note that if you have wirings other than the libraries "default", you will need to construct arguments to the library to specify the layout. See `LedMatrixOptions` for more information.
+
+[`rpi-led-matrix-sys`]: docs.rs/crate/rpi-led-matrix-sys
+[`rpi-led-matrix`]: docs.rs/crate/rpi-led-matrix

README.md

@@ -0,0 +1,3 @@
+{
+    "rust-analyzer.cargo.allFeatures": true
+}

build.rs

@@ -0,0 +1,10 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] - ???
+
+- Initial release

rpi-led-matrix-sys/.vscode/settings.json

@@ -0,0 +1,21 @@
+[package]
+name = "rpi-led-matrix-sys"
+version = "0.1.0"
+edition = "2018"
+description = "system library for the rpi-rgb-led-matrix C++ library"
+links = "rgbmatrixsys"
+build = "build.rs"
+license = "GPL-3.0"
+
+[dependencies]
+libc = "0.2"
+
+[build-dependencies]
+copy_dir = "0.1"
+
+[features]
+default = []
+c-stubs = []
+
+[package.metadata.docs.rs]
+all-features = true