improvements for libcsp cargo builder

CHANGELOG.md

@@ -8,6 +8,18 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 # [unreleased]
 
+# [v0.1.3] 2024-06-01
+
+Fixed documentation build.
+
+# [v0.1.2] 2024-06-01
+
+Restructured crate to be the root package of a workspace.
+
+# [v0.1.1] 2024-06-01
+
+Possible bugfix with dependency resolver not being able to select the correct `-sys` crate.
+
 # [v0.1.0] 2024-06-01
 
 Initial release

Cargo.lock

@@ -44,7 +44,7 @@ checksum = "97b3888a4aecf77e811145cadf6eef5901f4782c53886191b2f693f24761847c"
 
 [[package]]
 name = "libcsp"
-version = "0.1.0"
+version = "0.1.3"
 dependencies = [
  "bitflags",
  "libc",
@@ -54,7 +54,7 @@ dependencies = [
 
 [[package]]
 name = "libcsp-cargo-build"
-version = "0.1.0"
+version = "0.2.0"
 dependencies = [
  "cc",
 ]
@@ -69,7 +69,7 @@ dependencies = [
 
 [[package]]
 name = "libcsp-sys"
-version = "0.1.0"
+version = "0.1.1"
 dependencies = [
  "libc",
 ]

Cargo.toml

@@ -1,5 +1,25 @@
 [workspace]
 members = [
-    "libcsp-cargo-build", "libcsp", "libcsp-sys", "examples"
+    "libcsp-cargo-build",
+    "examples"
 ]
 resolver = "2"
+
+[package]
+name = "libcsp"
+version = "0.1.3"
+edition = "2021"
+authors = ["Robin Mueller <muellerr@irs.uni-stuttgart.de>"]
+description = "Safe and ergonomic Rust API for libcsp on top on libcsp-sys"
+homepage = "https://egit.irs.uni-stuttgart.de/rust/libcsp-rust"
+repository = "https://egit.irs.uni-stuttgart.de/rust/libcsp-rust"
+license = "Apache-2.0"
+keywords = ["no-std", "space", "aerospace", "ffi", "csp"]
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+categories = ["aerospace", "external-ffi-bindings", "no-std", "hardware-support", "embedded"]
+
+[dependencies]
+bitflags = "2"
+num_enum = "0.7"
+libc = "0.2"
+libcsp-sys = { version = "0.1", path = "libcsp-sys" }

README.md

@@ -1,3 +1,6 @@
+[![Crates.io](https://img.shields.io/crates/v/libcsp)](https://crates.io/crates/libcsp)
+[![docs.rs](https://img.shields.io/docsrs/libcsp)](https://docs.rs/libcsp)
+
 libcsp-rust
 =========
 
@@ -6,7 +9,7 @@ the [`libcsp`](https://github.com/libcsp/libcsp) C library in your Rust project.
 
 It provides 3 crates for this:
 
-- [`libcsp`](https://egit.irs.uni-stuttgart.de/rust/libcsp-rust/src/branch/main/libcsp-rust)
+- [`libcsp`](https://egit.irs.uni-stuttgart.de/rust/libcsp-rust/src/branch/main)
   provides a safe and ergonomic Rust interface on top of the `libcsp-sys` crate.
 - [`libcsp-sys`](https://egit.irs.uni-stuttgart.de/rust/libcsp-rust/src/branch/main/libcsp-sys)
   provides the Rust bindings to [`libcsp`](https://github.com/libcsp/libcsp).

clib/cfg/csp/autoconfig.h

@@ -1,4 +1,4 @@
-// This file was auto-generated by libcsp-cargo-build v0.1.0
+// This file was auto-generated by libcsp-cargo-build v0.2.0
 #define CSP_POSIX 1
 #define CSP_ZEPHYR 0
 

examples/Cargo.toml

@@ -4,7 +4,9 @@ version = "0.1.0"
 edition = "2021"
 
 [dependencies]
-libcsp =  { path = "../libcsp" }
+# Must use local verion here, otherwise there will be multiple versions of `libcsp-sys`, and
+# cargo can not deal with this due to the link section.
+libcsp = { version = "0.1", path = ".." }
 
 [build-dependencies]
-libcsp-cargo-build = { path = "../libcsp-cargo-build" }
+libcsp-cargo-build = { version = "0.2", path = "../libcsp-cargo-build" }

examples/autoconfig.h

@@ -1,4 +1,4 @@
-// This file was auto-generated by libcsp-cargo-build v0.1.0
+// This file was auto-generated by libcsp-cargo-build v0.2.0
 #define CSP_POSIX 1
 #define CSP_ZEPHYR 0
 

examples/autoconfig.rs

@@ -1,4 +1,4 @@
-// This file was auto-generated by libcsp-cargo-build v0.1.0
+// This file was auto-generated by libcsp-cargo-build v0.2.0
 pub const CSP_CONN_RXQUEUE_LEN: usize = 16;
 pub const CSP_QFIFO_LEN: usize = 16;
 pub const CSP_PORT_MAX_BIND: usize = 16;

examples/build.rs

@@ -11,7 +11,8 @@ fn main() {
 
     // This helper structure will take care of the majority of work to compile libcsp using the
     // cc crate.
-    let mut csp_builder = Builder::new(PathBuf::from(libcsp_path), PathBuf::from(&out_dir));
+    let mut csp_builder = Builder::new(PathBuf::from(libcsp_path), PathBuf::from(&out_dir))
+        .expect("creating libcsp builder failed");
     // A lot of spam we are not interested in usually.
     csp_builder.compiler_warnings = false;
 

examples/src/lib.rs

@@ -1 +0,0 @@
-

libcsp-cargo-build/CHANGELOG.md

@@ -8,6 +8,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 # [unreleased]
 
+# [v0.2.0] 2024-06-01
+
+Added basic sanity checks for the user-provided `libcsp` location.
+
 # [v0.1.0] 2024-06-01
 
 Initial release

libcsp-cargo-build/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "libcsp-cargo-build"
-version = "0.1.0"
+version = "0.2.0"
 edition = "2021"
 description = "Tools to build libcsp using cargo"
 homepage = "https://egit.irs.uni-stuttgart.de/rust/libcsp-rust"

libcsp-cargo-build/README.md

@@ -1,3 +1,6 @@
+[![Crates.io](https://img.shields.io/crates/v/libcsp-cargo-build)](https://crates.io/crates/libcsp-cargo-build)
+[![docs.rs](https://img.shields.io/docsrs/libcsp-cargo-build)](https://docs.rs/libcsp-cargo-build)
+
 libcsp-cargo-build
 ========
 

libcsp-cargo-build/src/lib.rs

@@ -133,12 +133,32 @@ pub struct Builder {
     build: cc::Build,
 }
 
+#[derive(Debug, Copy, Clone, PartialEq, Eq)]
+pub enum BuildCreationError {
+    PathDoesNotExist,
+    InvalidLibcspFormat,
+}
+
 impl Builder {
-    /// Create a new builder instance.
-    pub fn new(libcsp_path: PathBuf, out_dir: PathBuf) -> Self {
+    /// Create a new builder instance. Returns [BuildCreationError] if the specified libcsp path
+    /// does not exist or does not have the expected format.
+    pub fn new(libcsp_path: PathBuf, out_dir: PathBuf) -> Result<Self, BuildCreationError> {
+        // Basic sanity checks for the passed libcsp path.
+        if !libcsp_path.exists() {
+            return Err(BuildCreationError::PathDoesNotExist);
+        }
+        if !libcsp_path
+            .join("include")
+            .join("csp")
+            .join("csp.h")
+            .exists()
+        {
+            return Err(BuildCreationError::InvalidLibcspFormat);
+        }
+
         let mut libcsp_src_path_base = libcsp_path.clone();
         libcsp_src_path_base.push("src");
-        Self {
+        Ok(Self {
             generate_autoconf_file: true,
             libcsp_path,
             libcsp_src_path_base,
@@ -146,7 +166,7 @@ impl Builder {
             cfg: Default::default(),
             compiler_warnings: true,
             build: Default::default(),
-        }
+        })
     }
 
     /// Access to the underlying [cc::Build] builder object.

libcsp-sys/CHANGELOG.md

@@ -8,6 +8,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 # [unreleased]
 
+# [v0.1.1] 2024-06-01
+
+Try to fix the documentation build.
+
 # [v0.1.0] 2024-06-01
 
 Initial release

libcsp-sys/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "libcsp-sys"
-version = "0.1.0"
+version = "0.1.1"
 edition = "2021"
 authors = ["Robin Mueller <muellerr@irs.uni-stuttgart.de>"]
 description = "FFI bindings for libcsp"

libcsp-sys/README.md

@@ -1,3 +1,6 @@
+[![Crates.io](https://img.shields.io/crates/v/libcsp-sys)](https://crates.io/crates/libcsp-sys)
+[![docs.rs](https://img.shields.io/docsrs/libcsp-sys)](https://docs.rs/libcsp-sys)
+
 libcsp-sys
 ========
 

libcsp-sys/build.rs

@@ -15,19 +15,24 @@ fn main() {
         println!("cargo:rustc-link-lib=csp");
     }
 
-    let out_path = env::var("OUT_DIR").unwrap();
-    let csp_conf_dir = match env::var(ENV_KEY_CSP_CONFIG_DIR) {
-        Ok(conf_path) => conf_path,
-        Err(_e) => {
-            println!(
+    let mut csp_conf_path = if std::env::var("DOCS_RS").is_ok() {
+        PathBuf::from("./templates")
+    } else {
+        match env::var(ENV_KEY_CSP_CONFIG_DIR) {
+            Ok(conf_path) => conf_path.into(),
+            Err(_e) => {
+                println!(
                 "cargo:warning={} not set, using CARGO_MANIFEST_DIR to search for autoconfig.rs",
                 ENV_KEY_CSP_CONFIG_DIR
             );
-            env::var("CARGO_MANIFEST_DIR").expect("CARGO_MANIFEST_DIR not set")
+                env::var("CARGO_MANIFEST_DIR")
+                    .expect("CARGO_MANIFEST_DIR not set")
+                    .into()
+            }
         }
     };
-    let mut csp_conf_path = PathBuf::new();
-    csp_conf_path.push(csp_conf_dir);
+
+    let out_path = env::var("OUT_DIR").unwrap();
     csp_conf_path.push("autoconfig.rs");
     if !csp_conf_path.exists() {
         panic!(

libcsp/Cargo.toml

@@ -1,18 +0,0 @@
-[package]
-name = "libcsp"
-version = "0.1.0"
-edition = "2021"
-authors = ["Robin Mueller <muellerr@irs.uni-stuttgart.de>"]
-description = "Safe and ergonomic Rust API for libcsp on top on libcsp-sys"
-homepage = "https://egit.irs.uni-stuttgart.de/rust/libcsp-rust"
-repository = "https://egit.irs.uni-stuttgart.de/rust/libcsp-rust"
-license = "Apache-2.0"
-keywords = ["no-std", "space", "aerospace", "ffi", "csp"]
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-categories = ["aerospace", "external-ffi-bindings", "no-std", "hardware-support", "embedded"]
-
-[dependencies]
-bitflags = "2"
-num_enum = "0.7"
-libc = "0.2"
-libcsp-sys = { version = "0.1", path = "../libcsp-sys" }

libcsp/LICENSE-APACHE

@@ -1,201 +0,0 @@
-                              Apache License
-                        Version 2.0, January 2004
-                     http://www.apache.org/licenses/
-
-TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-1. Definitions.
-
-   "License" shall mean the terms and conditions for use, reproduction,
-   and distribution as defined by Sections 1 through 9 of this document.
-
-   "Licensor" shall mean the copyright owner or entity authorized by
-   the copyright owner that is granting the License.
-
-   "Legal Entity" shall mean the union of the acting entity and all
-   other entities that control, are controlled by, or are under common
-   control with that entity. For the purposes of this definition,
-   "control" means (i) the power, direct or indirect, to cause the
-   direction or management of such entity, whether by contract or
-   otherwise, or (ii) ownership of fifty percent (50%) or more of the
-   outstanding shares, or (iii) beneficial ownership of such entity.
-
-   "You" (or "Your") shall mean an individual or Legal Entity
-   exercising permissions granted by this License.
-
-   "Source" form shall mean the preferred form for making modifications,
-   including but not limited to software source code, documentation
-   source, and configuration files.
-
-   "Object" form shall mean any form resulting from mechanical
-   transformation or translation of a Source form, including but
-   not limited to compiled object code, generated documentation,
-   and conversions to other media types.
-
-   "Work" shall mean the work of authorship, whether in Source or
-   Object form, made available under the License, as indicated by a
-   copyright notice that is included in or attached to the work
-   (an example is provided in the Appendix below).
-
-   "Derivative Works" shall mean any work, whether in Source or Object
-   form, that is based on (or derived from) the Work and for which the
-   editorial revisions, annotations, elaborations, or other modifications
-   represent, as a whole, an original work of authorship. For the purposes
-   of this License, Derivative Works shall not include works that remain
-   separable from, or merely link (or bind by name) to the interfaces of,
-   the Work and Derivative Works thereof.
-
-   "Contribution" shall mean any work of authorship, including
-   the original version of the Work and any modifications or additions
-   to that Work or Derivative Works thereof, that is intentionally
-   submitted to Licensor for inclusion in the Work by the copyright owner
-   or by an individual or Legal Entity authorized to submit on behalf of
-   the copyright owner. For the purposes of this definition, "submitted"
-   means any form of electronic, verbal, or written communication sent
-   to the Licensor or its representatives, including but not limited to
-   communication on electronic mailing lists, source code control systems,
-   and issue tracking systems that are managed by, or on behalf of, the
-   Licensor for the purpose of discussing and improving the Work, but
-   excluding communication that is conspicuously marked or otherwise
-   designated in writing by the copyright owner as "Not a Contribution."
-
-   "Contributor" shall mean Licensor and any individual or Legal Entity
-   on behalf of whom a Contribution has been received by Licensor and
-   subsequently incorporated within the Work.
-
-2. Grant of Copyright License. Subject to the terms and conditions of
-   this License, each Contributor hereby grants to You a perpetual,
-   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-   copyright license to reproduce, prepare Derivative Works of,
-   publicly display, publicly perform, sublicense, and distribute the
-   Work and such Derivative Works in Source or Object form.
-
-3. Grant of Patent License. Subject to the terms and conditions of
-   this License, each Contributor hereby grants to You a perpetual,
-   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-   (except as stated in this section) patent license to make, have made,
-   use, offer to sell, sell, import, and otherwise transfer the Work,
-   where such license applies only to those patent claims licensable
-   by such Contributor that are necessarily infringed by their
-   Contribution(s) alone or by combination of their Contribution(s)
-   with the Work to which such Contribution(s) was submitted. If You
-   institute patent litigation against any entity (including a
-   cross-claim or counterclaim in a lawsuit) alleging that the Work
-   or a Contribution incorporated within the Work constitutes direct
-   or contributory patent infringement, then any patent licenses
-   granted to You under this License for that Work shall terminate
-   as of the date such litigation is filed.
-
-4. Redistribution. You may reproduce and distribute copies of the
-   Work or Derivative Works thereof in any medium, with or without
-   modifications, and in Source or Object form, provided that You
-   meet the following conditions:
-
-   (a) You must give any other recipients of the Work or
-       Derivative Works a copy of this License; and
-
-   (b) You must cause any modified files to carry prominent notices
-       stating that You changed the files; and
-
-   (c) You must retain, in the Source form of any Derivative Works
-       that You distribute, all copyright, patent, trademark, and
-       attribution notices from the Source form of the Work,
-       excluding those notices that do not pertain to any part of
-       the Derivative Works; and
-
-   (d) If the Work includes a "NOTICE" text file as part of its
-       distribution, then any Derivative Works that You distribute must
-       include a readable copy of the attribution notices contained
-       within such NOTICE file, excluding those notices that do not
-       pertain to any part of the Derivative Works, in at least one
-       of the following places: within a NOTICE text file distributed
-       as part of the Derivative Works; within the Source form or
-       documentation, if provided along with the Derivative Works; or,
-       within a display generated by the Derivative Works, if and
-       wherever such third-party notices normally appear. The contents
-       of the NOTICE file are for informational purposes only and
-       do not modify the License. You may add Your own attribution
-       notices within Derivative Works that You distribute, alongside
-       or as an addendum to the NOTICE text from the Work, provided
-       that such additional attribution notices cannot be construed
-       as modifying the License.
-
-   You may add Your own copyright statement to Your modifications and
-   may provide additional or different license terms and conditions
-   for use, reproduction, or distribution of Your modifications, or
-   for any such Derivative Works as a whole, provided Your use,
-   reproduction, and distribution of the Work otherwise complies with
-   the conditions stated in this License.
-
-5. Submission of Contributions. Unless You explicitly state otherwise,
-   any Contribution intentionally submitted for inclusion in the Work
-   by You to the Licensor shall be under the terms and conditions of
-   this License, without any additional terms or conditions.
-   Notwithstanding the above, nothing herein shall supersede or modify
-   the terms of any separate license agreement you may have executed
-   with Licensor regarding such Contributions.
-
-6. Trademarks. This License does not grant permission to use the trade
-   names, trademarks, service marks, or product names of the Licensor,
-   except as required for reasonable and customary use in describing the
-   origin of the Work and reproducing the content of the NOTICE file.
-
-7. Disclaimer of Warranty. Unless required by applicable law or
-   agreed to in writing, Licensor provides the Work (and each
-   Contributor provides its Contributions) on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-   implied, including, without limitation, any warranties or conditions
-   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-   PARTICULAR PURPOSE. You are solely responsible for determining the
-   appropriateness of using or redistributing the Work and assume any
-   risks associated with Your exercise of permissions under this License.
-
-8. Limitation of Liability. In no event and under no legal theory,
-   whether in tort (including negligence), contract, or otherwise,
-   unless required by applicable law (such as deliberate and grossly
-   negligent acts) or agreed to in writing, shall any Contributor be
-   liable to You for damages, including any direct, indirect, special,
-   incidental, or consequential damages of any character arising as a
-   result of this License or out of the use or inability to use the
-   Work (including but not limited to damages for loss of goodwill,
-   work stoppage, computer failure or malfunction, or any and all
-   other commercial damages or losses), even if such Contributor
-   has been advised of the possibility of such damages.
-
-9. Accepting Warranty or Additional Liability. While redistributing
-   the Work or Derivative Works thereof, You may choose to offer,
-   and charge a fee for, acceptance of support, warranty, indemnity,
-   or other liability obligations and/or rights consistent with this
-   License. However, in accepting such obligations, You may act only
-   on Your own behalf and on Your sole responsibility, not on behalf
-   of any other Contributor, and only if You agree to indemnify,
-   defend, and hold each Contributor harmless for any liability
-   incurred by, or claims asserted against, such Contributor by reason
-   of your accepting any such warranty or additional liability.
-
-END OF TERMS AND CONDITIONS
-
-APPENDIX: How to apply the Apache License to your work.
-
-   To apply the Apache License to your work, attach the following
-   boilerplate notice, with the fields enclosed by brackets "[]"
-   replaced with your own identifying information. (Don't include
-   the brackets!)  The text should be enclosed in the appropriate
-   comment syntax for the file format. We also recommend that a
-   file or class name and description of purpose be included on the
-   same "printed page" as the copyright notice for easier
-   identification within third-party archives.
-
-Copyright [yyyy] [name of copyright owner]
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-	http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.

libcsp/NOTICE

@@ -1 +0,0 @@
-This software contains code developed at the University of Stuttgart's Institute of Space Systems.

libcsp/README.md

@@ -1,11 +0,0 @@
-libcsp-rust
-========
-
-This crate provides a (mostly) safe and ergonomic Rust API for the
-[`libcsp` library](https://github.com/libcsp/libcsp) on top of the
-[`libcsp-sys`](https://crates.io/crates/libcsp-sys) crate.
-
-You can find some more high-level information and examples in the
-[main repository](https://egit.irs.uni-stuttgart.de/rust/libcsp-rust).
-
-The API documentation should provide all additional information required to use this library.