crate split done

Cargo.toml

@@ -1,5 +1,5 @@
 [workspace]
 members = [
-    "libcsp-cargo-build", "libcsp", "libcsp-sys", "examples"
+    "libcsp-cargo-build", "libcsp-rust", "libcsp-sys", "examples"
 ]
 resolver = "2"

README.md

@@ -1,31 +1,33 @@
 libcsp-rust
 =========
 
-This project aims to provide libraries and tools build and use
+This project aims to provide libraries and tools to build and use
-[`libcsp`](https://github.com/libcsp/libcsp) in your Rust project.
+the [`libcsp`](https://github.com/libcsp/libcsp) C library in your Rust project.
 
-It provides 2 crates for this:
+It provides 3 crates for this:
 
+- [`libcsp`](https://egit.irs.uni-stuttgart.de/rust/libcsp-rust/src/branch/main/libcsp-rust)
+  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`.
 - [`libcsp-cargo-build`](https://egit.irs.uni-stuttgart.de/rust/libcsp-rust/src/branch/main/libcsp-cargo-build)
   provides an API to build the `libcsp` using `cargo` with the [`cc`](https://docs.rs/cc/latest/cc/) crate.
-- [`libcsp-rust`](https://egit.irs.uni-stuttgart.de/rust/libcsp-rust/src/branch/main/libcsp-rust)
-  provides the Rust bindings to `libcsp` and a safe and ergonomic Rust interface.
 
-In addition, it provides a workspace to allow updating the `libcsp` and the corresponding bindings
+In addition, it provides a workspace to allow updating the `libcsp` C sources and the corresponding
-more easily inside the `lib` directory. Some of the examples `libcsp` provides were ported to Rust
+bindings more easily inside the `clib` directory. Some of the examples `libcsp` provides were ported
-and are showcases in the `examples` directory.
+to Rust and are showcased in the `examples` directory.
 
 ## How it works
 
 We assume that cargo should also take care of building the library.
 
 1. Add the `libcsp-cargo-build` as a build dependency inside your `Cargo.toml`.
-2. Add the `libcsp-rust` as a regular dependency inside your `Cargo.toml`.
+2. Add the `libcsp` as a regular dependency inside your `Cargo.toml`.
-3. Create a custom `build.rs` script which takes care of building `libcsp` using the API
+3. Create a custom `build.rs` script which takes care of building the `libcsp` C library using the
-   provided by `libcsp-cargo-build`. You have to provide the source code for `libcsp` inside some
+   API provided by `libcsp-cargo-build`. You have to provide the source code for `libcsp` inside
-   directory and pass the directory path to a builder API.
+   some directory and pass the directory path to the builder API.
-4. You can now write regular Rust code and use the API provided by `libcsp-rust` to use `libcsp`
+4. You can now write regular Rust code and use the Rust API provided by the `libcsp` crate to use
-   in a safe and Rusty way.
+   the `libcsp` C library.
 
 It is recommended to have a look at the [example build script](https://egit.irs.uni-stuttgart.de/rust/libcsp-rust/src/branch/main/examples/build.rs)
 which should give you a general idea of how a build script might look like to integrate `libcsp`.
@@ -40,9 +42,9 @@ in Rust. You can run the example using the following steps:
    script or adding `libcsp` as a git submodule.
 2. You can now use `cargo run -p libcsp-rust-examples` to run the server/client example.
 
-## Compile-time configuration of the `libcsp-rust` library
+## Compile-time configuration of the `libcsp-sys` library
 
-The `libcsp-rust` library requires some compile-time configuration file to be included to work
+The `libcsp-sys` requires some compile-time configuration file to be included to work
 properly. You can see an example version of the file for the workspace
 [here](https://egit.irs.uni-stuttgart.de/rust/libcsp-rust/src/branch/main/examples/autoconfig.rs).
 The user has to provide the path to a directory containing this `autoconfig.rs` file using the
@@ -60,10 +62,10 @@ configuration:
 CSP_CONFIG_DIR = { value = "examples", relative = true }
 ```
 
-## Generating and update the bindings using the `lib` folder
+## Generating and update the bindings using the `clib` folder
 
 The `lib` folder in this repository serves as the staging directory for the `libcsp` library to
-build. However, it can also be used to update the bindings provided in `libcsp-rust` by providing
+build. However, it can also be used to update the bindings provided in `libcsp-sys` by providing
 some tools and helpers to auto-generate and update the bindings file `bindings.rs`.
 
 If you want to do this, you should install `bindgen-cli` first:
@@ -74,7 +76,7 @@ cargo install bindgen-cli --locked
 
 `bindgen` needs some additional information provided by the user to generate the bindings:
 An `autoconfig.h` file which is used to configure `libcsp`. Normally, this file is generated
-by the C build system. This file is located at `cfg/csp` and is also updated automatically
+by the C build system. This file is located at `clib/cfg/csp` and is also updated automatically
 when running the example application.
 
 After cloning the repository, you can now run the following command to re-generate the bindings
@@ -85,4 +87,4 @@ bindgen --use-core wrapper.h -- "-I./libcsp/include" "-I./cfg" "-I./libcsp/src"
 ```
 
 With the bindings file, you can now manually update the FFI bindings provided in
-`libcsp-rust/src/ffi.rs` or in your own CSP library.
+`libcsp-sys/src/lib.rs` or in your own CSP library.

libcsp-sys/LICENSE-APACHE

@@ -0,0 +1,201 @@
+                              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-sys/NOTICE

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

libcsp-sys/README.md

@@ -0,0 +1,21 @@
+libcsp-sys
+========
+
+This crate provides FFI bindings for the [`libcsp` library](https://github.com/libcsp/libcsp).
+
+Generally, you probably do not want to use this library directly and instead use the
+`libcsp` Rust crate which provides a safe and ergonomic Rust API.
+You can find some more high-level information and examples in the
+[main repository](https://egit.irs.uni-stuttgart.de/rust/libcsp-rust).
+
+## Compile-time configuration of the `libcsp-rust` library
+
+The `libcsp-rust` library requires some compile-time configuration file to be included to work
+properly. You can see an example version of the file for the workspace
+[here](https://egit.irs.uni-stuttgart.de/rust/libcsp-rust/src/branch/main/examples/autoconfig.rs).
+The user has to provide the path to a directory containing this `autoconfig.rs` file using the
+`CSP_CONFIG_DIR` environmental variable.
+
+It is recommended to read the [main workspace README](https://egit.irs.uni-stuttgart.de/rust/libcsp-rust)
+for more information to make the generation and specification of this auto-configuration file
+as conveniently and easy as possible.

libcsp/README.md

@@ -1,9 +1,10 @@
 libcsp-rust
 ========
 
-This crate provides Rust FFI bindings and a Rusty API for the [`libcsp` library](https://github.com/libcsp/libcsp).
+This crate provides a (mostly) safe and ergonomic Rust API for the
-You can find some more high-level information and examples in the
+[`libcsp` library](https://github.com/libcsp/libcsp) on top of the `libcsp-sys`
-[main workspace](https://egit.irs.uni-stuttgart.de/rust/libcsp-rust).
+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.