Rust API

.gitignore

@@ -1,4 +1,5 @@
 include
+target/
 *.tgz
 *.tar.gz
 *.o
@@ -26,3 +27,4 @@ install
 build
 .vscode
 .vs
+Cargo.lock

CMakeLists.txt

@@ -12,6 +12,8 @@ option(GRAVITY_USE_EXTERNAL_PROTOBUF "Download, Build and Use an externally down
 option(GRAVITY_USE_EXTERNAL_ZEROMQ "Download, build and use and externally downloaded ZeroMQ build")
 option(GRAVITY_USE_EXTERNAL_SPDLOG "Download, build and use an externally downloaded Spdlog build")
 option(BUILD_EXAMPLES_TESTS "Build Gravity examples and tests" ON)
+option(BUILD_LIBRARY_ONLY "Only build the libraries, without components or tests")
+option(BUILD_STATIC_LIBRARIES "Build libraries to link statically (useful for linking with Rust)")
 option(SKIP_JAVA "Skip building Gravity Java wrapper")
 option(SKIP_PYTHON "Skip building Gravity Python wrapper") 
 set(JAVA_HOME "" CACHE PATH "Path to JDK to use")
@@ -42,6 +44,11 @@ endif()
 set(PUBLIC_STAGING_DIR ${CMAKE_BINARY_DIR}/staging)
 
 macro(add_external_protobuf)
+    if (NOT BUILD_STATIC_LIBRARIES)
+        set(BUILD_SHARED_LIBS_PROTO ON)
+    else() 
+        set(BUILD_SHARED_LIBS_PROTO OFF)
+    endif()
     ExternalProject_Add(    
         protobuf_external
         SOURCE_DIR "${CMAKE_CURRENT_BINARY_DIR}/protobuf"
@@ -53,7 +60,7 @@ macro(add_external_protobuf)
         LOG_OUTPUT_ON_FAILURE ON
         CMAKE_ARGS
             -DCMAKE_INSTALL_PREFIX=${PUBLIC_STAGING_DIR}
-            -Dprotobuf_BUILD_SHARED_LIBS:BOOL=ON
+            -Dprotobuf_BUILD_SHARED_LIBS:BOOL=${BUILD_SHARED_LIBS_PROTO}
             -Dprotobuf_MSVC_STATIC_RUNTIME:BOOL=OFF
             -Dprotobuf_BUILD_TESTS:BOOL=OFF
             -Dprotobuf_BUILD_EXAMPLES:BOOL=OFF
@@ -78,7 +85,7 @@ macro(add_external_libzmq)
         CMAKE_ARGS
             -DCMAKE_INSTALL_PREFIX=${PUBLIC_STAGING_DIR}
             -DBUILD_SHARED:BOOL=ON
-            -DBUILD_STATIC:BOOL=OFF
+            -DBUILD_STATIC:BOOL=${BUILD_STATIC_LIBRARIES}
             -DZMQ_BUILD_TESTS:BOOL=OFF
             -DBUILD_TESTS:BOOL=OFF
         BUILD_COMMAND cmake --build .  --config $<$<CONFIG:Debug>:debug>$<$<CONFIG:Release>:release>
@@ -266,11 +273,13 @@ if (NOT depends)
     set(GRAVITY_ROOT "${CMAKE_INSTALL_PREFIX}")
     set(CMAKE_PREFIX_PATH ${CMAKE_PREFIX_PATH_ALT_SEP})
 
-    include(CTest)
-    add_subdirectory(test)
+    if (NOT BUILD_LIBRARY_ONLY)
+        include(CTest)
+        add_subdirectory(test)
 
-    set(CPACK_GENERATOR "TGZ")
-    include(CPack)
+        set(CPACK_GENERATOR "TGZ")
+        include(CPack)
+    endif()
 
     message(STATUS "No external libraries - doing a toplevel build")
 else()
@@ -286,6 +295,8 @@ else()
             -DSKIP_JAVA=${SKIP_JAVA}
             -DSKIP_PYTHON=${SKIP_PYTHON}
             -DZMQ_HOME=${ZMQ_HOME}
+            -DBUILD_LIBRARY_ONLY=${BUILD_LIBRARY_ONLY}
+            -DBUILD_STATIC_LIBRARIES=${BUILD_STATIC_LIBRARIES}
             -DGRAVITY_USE_EXTERNAL_PROTOBUF=${GRAVITY_USING_EXTERNAL_PROTOBUF}
             -DGRAVITY_USE_EXTERNAL_ZEROMQ=${GRAVITY_USING_EXTERNAL_ZEROMQ}
             -DGRAVITY_USE_EXTERNAL_SPDLOG=${GRAVITY_USING_EXTERNAL_SPDLOG}
@@ -306,7 +317,7 @@ else()
 
 
 
-    if (BUILD_EXAMPLES_TESTS)
+    if (BUILD_EXAMPLES_TESTS AND NOT BUILD_LIBRARY_ONLY)
         ExternalProject_Add(
             gravity_external_examples_tests
             DEPENDS gravity_external

Cargo.toml

@@ -0,0 +1,24 @@
+[package]
+name = "gravity"
+version = "0.1.0"
+edition = "2024"
+description = "Rust bindings for the Gravity software framework"
+readme = "README.md"
+license-file = "LICENSE"
+repository = "https://github.com/astrauc/gravity.git"
+keywords = ["FFI", "C++", "Gravity"]
+exclude = ["src/api/rust/target"]
+build = "src/api/rust/build.rs"
+
+[lib]
+path = "src/api/rust/src/lib.rs"
+
+[dependencies]
+cxx = "1.0.158"
+protobuf = "3.7.2"
+
+[build-dependencies]
+cxx-build = "1.0.158"
+cmake = "0.1"
+protobuf-codegen = "3.7.2"
+

src/CMakeLists.txt

@@ -25,19 +25,22 @@ endif()
 add_subdirectory(keyvalue_parser)
 add_subdirectory(api/protobufs)
 add_subdirectory(api/cpp)
+
 if (NOT SKIP_JAVA)
     add_subdirectory(api/java/src/swig)
     add_subdirectory(api/java/src/cpp)
     add_subdirectory(api/java)
     add_subdirectory(api/MATLAB)
 endif()
 
-add_subdirectory(components/cpp/ServiceDirectory)
-add_subdirectory(components/cpp/Archiver)
-add_subdirectory(components/cpp/ConfigServer)
-add_subdirectory(components/cpp/LogRecorder)
-add_subdirectory(components/cpp/Playback)
-add_subdirectory(components/cpp/Relay)
+if (NOT BUILD_LIBRARY_ONLY)
+    add_subdirectory(components/cpp/ServiceDirectory)
+    add_subdirectory(components/cpp/Archiver)
+    add_subdirectory(components/cpp/ConfigServer)
+    add_subdirectory(components/cpp/LogRecorder)
+    add_subdirectory(components/cpp/Playback)
+    add_subdirectory(components/cpp/Relay)
+endif()
 
 if (NOT SKIP_PYTHON)
     add_subdirectory(api/python/src/swig)

src/api/cpp/CMakeLists.txt

@@ -104,8 +104,11 @@ set(SRCS
 	"${CMAKE_CURRENT_LIST_DIR}/Utility.cpp")
 
 
-
-add_library(${PROTO_LIB_NAME} SHARED ${PROTO_SRCS} ${PROTO_HDRS})
+if (NOT BUILD_STATIC_LIBRARIES)
+	add_library(${PROTO_LIB_NAME} SHARED ${PROTO_SRCS} ${PROTO_HDRS})
+else()
+	add_library(${PROTO_LIB_NAME} STATIC ${PROTO_SRCS} ${PROTO_HDRS})
+endif()
 target_link_libraries(${PROTO_LIB_NAME} PUBLIC protobuf::libprotobuf)
 add_dependencies(${PROTO_LIB_NAME} ${LIB_NAME}_protos)
 install(TARGETS ${PROTO_LIB_NAME} EXPORT ${PROJECT_NAME}-targets ARCHIVE DESTINATION lib RUNTIME DESTINATION bin)
@@ -118,7 +121,12 @@ endif()
 
 add_definitions(-DGRAVITY_EXPORTS -D_USRDLL)
 include_directories("${CMAKE_BINARY_DIR}")
-add_library(${LIB_NAME} SHARED ${SRCS})
+if (NOT BUILD_STATIC_LIBRARIES)
+	add_library(${LIB_NAME} SHARED ${SRCS})
+else()
+	add_library(${LIB_NAME} STATIC ${SRCS})
+endif()
+
 add_dependencies(${LIB_NAME} ${PROTO_LIB_NAME})
 gravity_add_dependency(${LIB_NAME})
 target_include_directories(${LIB_NAME} INTERFACE
@@ -160,7 +168,8 @@ if (GIT_EXE)
         message(STATUS "${GIT_EXE} FAILED: ${STATUS}")
     else()
         message(STATUS "${GIT_EXE} SUCCESS: ${OUTPUT2}")
-        add_custom_command(TARGET ${LIB_NAME} POST_BUILD COMMAND "${GIT_EXE}" describe --tag --dirty > "${CMAKE_BINARY_DIR}/VERSION.txt")
+        add_custom_command(TARGET ${LIB_NAME} POST_BUILD COMMAND "${GIT_EXE}" describe --tag --dirty > "${CMAKE_BINARY_DIR}/VERSION.txt"
+			|| echo "0.0.0-unknown" > "${CMAKE_BINARY_DIR}/VERSION.txt")
         INSTALL(FILES "${CMAKE_BINARY_DIR}/VERSION.txt" DESTINATION .)
     endif()
 endif()

src/api/rust/.gitignore

@@ -0,0 +1,5 @@
+target/
+build/
+Cargo.lock
+*.log
+Testing/

src/api/rust/README.md

@@ -0,0 +1,46 @@
+# Rust for Gravity
+
+A Rust API for gravity
+
+## Usage
+
+### Dependencies 
+
+**Requires cargo 1.85 or later**
+On linux, this can be easily installed through the following:
+```sh
+sudo apt install rustup
+rustup update stable
+```
+
+Rustup will automatically install the latest stable release of rust compiler.
+
+
+Before you add it to your ```Cargo.toml```, ensure that you have all the Gravity dependencies installed, specified in the [Gravity Build Guide](https://github.com/aphysci/gravity/wiki/GravitySetup).
+
+Not all are necessary, just g++, cmake, bison, flex.
+
+In linux:
+```sh
+sudo apt install cmake g++ bison flex
+```
+Using cmake version 4.x.x or later does not work with Gravity. apt installs version 3.28 which has been tested with Gravity and the Cargo build.
+
+Then, add the crate to your Cargo.toml:
+```toml
+[dependencies]
+gravity = { git = "REPOSITORY_URL" }
+```
+
+You are done! Now you can use Gravity from your Rust application!
+
+> [!NOTE]
+> Using Gravity this way does not create/run the ServiceDirectory. Follow the [Gravity Build Guide](https://github.com/aphysci/gravity/wiki/GravitySetup) to set that up.
+>
+
+## Tests
+To run the unit tests, you need a Service Directory running. Then simply run ``` cargo test ```. As long you are not in the examples folder, the folder you run it in does not matter. (If you are in the examples it will run the specific example)
+
+## Runnable examples
+
+Once there is a ServiceDirectory setup, go into the example directory you want to run and ``` cargo run ```

src/api/rust/bridge/RustFutureResponse.cpp

@@ -0,0 +1,16 @@
+#include "RustFutureResponse.h"
+
+namespace gravity {
+
+    std::shared_ptr<FutureResponse> rustNewFutureResponse(const char* arrayPtr, int size)
+    {
+        return std::shared_ptr<FutureResponse>(new FutureResponse(arrayPtr, size));
+    }
+
+    void rustSetResponse(const std::unique_ptr<FutureResponse>& fr, const std::unique_ptr<GravityDataProduct>& response)
+    {
+        fr->setResponse(*response);
+    }
+
+
+} // namespace gravity

src/api/rust/bridge/RustFutureResponse.h

@@ -0,0 +1,21 @@
+#ifndef RUSTFUTURERESPONSE_H_
+#define RUSTFUTURERESPONSE_H_
+
+
+#include <FutureResponse.h>
+
+
+
+namespace gravity
+{
+    /* Future response things*/
+    std::shared_ptr<FutureResponse> rustNewFutureResponse(const char* arrayPtr, int size);
+
+    void rustSetResponse(const std::unique_ptr<FutureResponse>& fr, const std::unique_ptr<GravityDataProduct>& response);
+
+
+
+} // namespace gravity
+
+
+#endif