Squashed commit of the following:

commit aa9b119
Author: Jan Range <[email protected]>
Date:   Tue Apr 29 14:58:37 2025 +0200

    Property macro (#12)

    * remove unused print statements

    * update deps

    * add `property` macros

    * generate setter and getter methods via `property`

    * encapsulate url for docs

    * use inline code fence for docs

    * remove newline

    * update docs

    * update docs

    * fix clippy issue

Author: JR-1991

.cursorignore

@@ -1,4 +1,3 @@
-target/
 vendors/
 .clippy_output.txt
 tarpaulin-report.html

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+    "cmake.sourceDirectory": "/Users/janrange/Documents/playground/libsbml-sys/vendors/libsbml"
+}

Cargo.lock

@@ -9,7 +9,6 @@ cxx = "1.0.140"
 paste = "1.0.15"
 quick-xml = { version = "0.37.2", features = ["serialize"] }
 serde = { version = "1.0.217", features = ["derive"] }
-thiserror = "2.0.12"
 
 
 [build-dependencies]

Cargo.toml

@@ -87,7 +87,6 @@ fn main() -> miette::Result<()> {
 /// * `miette::Result<String>` - Build directory path on success, error on failure
 fn build_and_link_libsbml(dep_build: &str) -> miette::Result<String> {
     let dst = if cfg!(target_os = "windows") {
-        println!("cargo:warning=Building libSBML for Windows");
         // In order to build for windows, we need to carefully tell CMake
         // where to find the libraries and headers for libexpat and zlib.
         // This is necessary because the libraries are not installed in the
@@ -121,7 +120,6 @@ fn build_and_link_libsbml(dep_build: &str) -> miette::Result<String> {
             .define("BUILD_SHARED_LIBS", "OFF")
             .build()
     } else {
-        println!("cargo:warning=Building libSBML for MacOS/Linux");
         // When building for MacOS and Linux, we can just use the system libraries
         cmake::Config::new(LIBSBML_PATH)
             .profile("Release")
@@ -172,8 +170,6 @@ fn build_and_link_libsbml(dep_build: &str) -> miette::Result<String> {
 /// # Returns
 /// * `miette::Result<String>` - Build directory path on success, error on failure
 fn build_and_link_sbml_deps() -> miette::Result<String> {
-    println!("cargo:warning=Building libSBML dependencies");
-
     // Build the dependencies for libSBML
     // We hard-code to EXPAT and ZLIB for now, but in the future this should
     // be made more flexible.

build.rs

@@ -9,12 +9,11 @@
 
 use std::{cell::RefCell, pin::Pin, rc::Rc};
 
-use autocxx::c_uint;
 use cxx::let_cxx_string;
 
 use crate::{
-    clone, inner, into_id, model::Model, pin_ptr, sbmlcxx, sbo_term, traits::fromptr::FromPtr,
-    upcast_annotation,
+    clone, inner, into_id, model::Model, optional_property, pin_ptr, required_property, sbmlcxx,
+    sbo_term, traits::fromptr::FromPtr, upcast_annotation,
 };
 
 /// A safe wrapper around the libSBML Compartment class.
@@ -61,145 +60,64 @@ impl<'a> Compartment<'a> {
         }
     }
 
-    /// Gets the compartment's identifier.
-    ///
-    /// # Returns
-    /// The compartment's ID as a String
-    pub fn id(&self) -> String {
-        self.inner.borrow().getId().to_str().unwrap().to_string()
-    }
-
-    /// Sets the compartment's identifier.
-    ///
-    /// # Arguments
-    /// * `id` - The new identifier to set
-    pub fn set_id(&self, id: &str) {
-        let_cxx_string!(id = id);
-        self.inner.borrow_mut().as_mut().setId(&id);
-    }
-
-    /// Gets the compartment's name.
-    ///
-    /// # Returns
-    /// The compartment's name as a String
-    pub fn name(&self) -> String {
-        self.inner.borrow().getName().to_str().unwrap().to_string()
-    }
-
-    /// Sets the compartment's name.
-    ///
-    /// # Arguments
-    /// * `name` - The new name to set
-    pub fn set_name(&self, name: &str) {
-        let_cxx_string!(name = name);
-        self.inner.borrow_mut().as_mut().setName(&name);
-    }
-
-    /// Gets the spatial dimensions of the compartment.
-    ///
-    /// # Returns
-    /// The number of spatial dimensions as a u32
-    pub fn spatial_dimensions(&self) -> u32 {
-        self.inner.borrow().getSpatialDimensions().0
-    }
-
-    /// Sets the spatial dimensions of the compartment.
-    ///
-    /// # Arguments
-    /// * `spatial_dimensions` - The number of spatial dimensions to set (typically 0-3)
-    pub fn set_spatial_dimensions(&self, spatial_dimensions: u32) {
-        self.inner
-            .borrow_mut()
-            .as_mut()
-            .setSpatialDimensions(c_uint::from(spatial_dimensions));
-    }
-
-    /// Gets the unit of measurement for the compartment.
-    ///
-    /// # Returns
-    /// The unit of measurement as a String (e.g., "litre", "metre^3")
-    pub fn unit(&self) -> String {
-        self.inner.borrow().getUnits().to_str().unwrap().to_string()
-    }
-
-    /// Sets the unit of measurement for the compartment.
-    ///
-    /// # Arguments
-    /// * `unit` - The unit of measurement to set (e.g., "litre", "metre^3")
-    pub fn set_unit(&self, unit: &str) {
-        let_cxx_string!(unit = unit);
-        self.inner.borrow_mut().as_mut().setUnits(&unit);
-    }
-
-    /// Gets the size of the compartment.
-    ///
-    /// # Returns
-    /// The size as a f64 in the units specified by the compartment's units attribute
-    pub fn size(&self) -> f64 {
-        self.inner.borrow().getSize()
-    }
-
-    /// Sets the size of the compartment.
-    ///
-    /// # Arguments
-    /// * `size` - The size to set in the units specified by the compartment's units attribute
-    pub fn set_size(&self, size: f64) {
-        self.inner.borrow_mut().as_mut().setSize(size);
-    }
-
-    /// Gets the volume of the compartment.
-    ///
-    /// # Returns
-    /// The volume as a f64 in the units specified by the compartment's units attribute
-    pub fn volume(&self) -> f64 {
-        self.inner.borrow().getVolume()
-    }
-
-    /// Sets the volume of the compartment.
-    ///
-    /// # Arguments
-    /// * `volume` - The volume to set in the units specified by the compartment's units attribute
-    pub fn set_volume(&self, volume: f64) {
-        self.inner.borrow_mut().as_mut().setVolume(volume);
-    }
-
-    /// Gets whether the compartment is constant.
-    ///
-    /// # Returns
-    /// true if the compartment's size is constant over time, false otherwise
-    pub fn constant(&self) -> bool {
-        self.inner.borrow().getConstant()
-    }
-
-    /// Sets whether the compartment is constant.
-    ///
-    /// # Arguments
-    /// * `constant` - true if the compartment's size should be constant over time, false otherwise
-    pub fn set_constant(&self, constant: bool) {
-        self.inner.borrow_mut().as_mut().setConstant(constant);
-    }
-
-    /// Gets the outside compartment reference.
-    ///
-    /// # Returns
-    /// The ID of the containing (outside) compartment as a String
-    pub fn outside(&self) -> String {
-        self.inner
-            .borrow()
-            .getOutside()
-            .to_str()
-            .unwrap()
-            .to_string()
-    }
-
-    /// Sets the outside compartment reference.
-    ///
-    /// # Arguments
-    /// * `outside` - The ID of the containing (outside) compartment to set
-    pub fn set_outside(&self, outside: &str) {
-        let_cxx_string!(outside = outside);
-        self.inner.borrow_mut().as_mut().setOutside(&outside);
-    }
+    // Getter and setter methods for the id property
+    required_property!(Compartment<'a>, id, String, getId, setId);
+
+    // Getter and setter methods for the name property
+    optional_property!(Compartment<'a>, name, String, getName, setName, isSetName);
+
+    // Getter and setter methods for the spatial dimensions property
+    optional_property!(
+        Compartment<'a>,
+        spatial_dimensions,
+        u32,
+        getSpatialDimensions,
+        setSpatialDimensions,
+        isSetSpatialDimensions
+    );
+
+    // Getter and setter methods for the unit property
+    optional_property!(
+        Compartment<'a>,
+        unit,
+        String,
+        getUnits,
+        setUnits,
+        isSetUnits
+    );
+
+    // Getter and setter methods for the size property
+    optional_property!(Compartment<'a>, size, f64, getSize, setSize, isSetSize);
+
+    // Getter and setter methods for the volume property
+    optional_property!(
+        Compartment<'a>,
+        volume,
+        f64,
+        getVolume,
+        setVolume,
+        isSetVolume
+    );
+
+    // Getter and setter methods for the constant property
+    optional_property!(
+        Compartment<'a>,
+        constant,
+        bool,
+        getConstant,
+        setConstant,
+        isSetConstant
+    );
+
+    // Getter and setter methods for the outside property
+    optional_property!(
+        Compartment<'a>,
+        outside,
+        String,
+        getOutside,
+        setOutside,
+        isSetOutside
+    );
 
     // SBO Term Methods generated by the `sbo_term` macro
     sbo_term!(sbmlcxx::Compartment, sbmlcxx::SBase);
@@ -372,21 +290,21 @@ mod tests {
 
         // Use all setters to set all properties
         compartment.set_name("test");
-        compartment.set_spatial_dimensions(3);
+        compartment.set_spatial_dimensions(3u32);
         compartment.set_unit("test");
         compartment.set_size(1.0);
         compartment.set_volume(1.0);
         compartment.set_outside("test");
         compartment.set_constant(true);
 
         assert_eq!(compartment.id(), "test");
-        assert_eq!(compartment.name(), "test");
-        assert_eq!(compartment.spatial_dimensions(), 3);
-        assert_eq!(compartment.unit(), "test");
-        assert_eq!(compartment.size(), 1.0);
-        assert_eq!(compartment.volume(), 1.0);
-        assert_eq!(compartment.outside(), "test");
-        assert!(compartment.constant());
+        assert_eq!(compartment.name(), Some("test".to_string()));
+        assert_eq!(compartment.spatial_dimensions(), Some(3));
+        assert_eq!(compartment.unit(), Some("test".to_string()));
+        assert_eq!(compartment.size(), Some(1.0));
+        assert_eq!(compartment.volume(), Some(1.0));
+        assert_eq!(compartment.outside(), Some("test".to_string()));
+        assert_eq!(compartment.constant(), Some(true));
     }
 
     #[test]
@@ -404,13 +322,13 @@ mod tests {
             .build();
 
         assert_eq!(compartment.id(), "test");
-        assert_eq!(compartment.name(), "test");
-        assert_eq!(compartment.spatial_dimensions(), 3);
-        assert_eq!(compartment.unit(), "test");
-        assert_eq!(compartment.size(), 1.0);
-        assert_eq!(compartment.volume(), 1.0);
-        assert_eq!(compartment.outside(), "test");
-        assert!(compartment.constant());
+        assert_eq!(compartment.name(), Some("test".to_string()));
+        assert_eq!(compartment.spatial_dimensions(), Some(3));
+        assert_eq!(compartment.unit(), Some("test".to_string()));
+        assert_eq!(compartment.size(), Some(1.0));
+        assert_eq!(compartment.volume(), Some(1.0));
+        assert_eq!(compartment.outside(), Some("test".to_string()));
+        assert_eq!(compartment.constant(), Some(true));
     }
 
     #[test]