siderust-js 0.1.0

package/tempoch-js/tempoch/tempoch-ffi/Cargo.toml

@@ -0,0 +1,26 @@
+[package]
+name = "tempoch-ffi"
+version = "0.1.0"
+edition = "2021"
+authors = ["VPRamon <vallespuigramon@gmail.com>"]
+description = "C FFI bindings for tempoch — astronomical time primitives."
+license = "AGPL-3.0-only"
+repository = "https://github.com/Siderust/tempoch"
+
+[lib]
+name = "tempoch_ffi"
+crate-type = ["cdylib", "staticlib", "rlib"]
+
+[features]
+default = []
+serde = ["tempoch/serde", "dep:serde_json"]
+
+[dependencies]
+tempoch = { path = "../tempoch", version = "0.3.0" }
+qtty = "0.4.0"
+qtty-ffi = "0.3.1"
+chrono = "0.4.44"
+serde_json = { version = "1.0", optional = true }
+
+[build-dependencies]
+cbindgen = "0.29.2"

package/tempoch-js/tempoch/tempoch-ffi/build.rs

@@ -0,0 +1,24 @@
+use std::env;
+use std::path::PathBuf;
+
+fn main() {
+    let crate_dir = env::var("CARGO_MANIFEST_DIR").unwrap();
+    let out_dir = PathBuf::from(env::var("OUT_DIR").unwrap());
+    let include_dir = PathBuf::from(&crate_dir).join("include");
+
+    let config =
+        cbindgen::Config::from_file("cbindgen.toml").expect("Unable to read cbindgen.toml");
+
+    let bindings = cbindgen::Builder::new()
+        .with_crate(&crate_dir)
+        .with_config(config)
+        .generate()
+        .expect("Unable to generate C bindings");
+
+    // Write to OUT_DIR (standard cargo location)
+    bindings.write_to_file(out_dir.join("tempoch_ffi.h"));
+
+    // Also write to include/ for easy consumption by C/C++ projects
+    std::fs::create_dir_all(&include_dir).expect("Unable to create include directory");
+    bindings.write_to_file(include_dir.join("tempoch_ffi.h"));
+}

package/tempoch-js/tempoch/tempoch-ffi/cbindgen.toml

@@ -0,0 +1,30 @@
+language = "C"
+include_guard = "TEMPOCH_FFI_H"
+autogen_warning = "/* Warning: this file is auto-generated by cbindgen. Do not modify manually. */"
+documentation_style = "c99"
+style = "both"
+cpp_compat = true
+after_includes = """
+/* QttyQuantity and UnitId definitions come from qtty_ffi.h */
+#include "qtty_ffi.h"
+"""
+
+[defines]
+"feature = serde" = "TEMPOCH_FFI_HAS_SERDE"
+
+[export]
+# Exclude qtty-ffi types — they come from qtty_ffi.h (included via after_includes)
+exclude = ["QttyQuantity", "UnitId", "DimensionId", "QttyDerivedQuantity"]
+
+[export.rename]
+"TempochStatus" = "tempoch_status_t"
+"TempochUtc" = "tempoch_utc_t"
+"TempochPeriodMjd" = "tempoch_period_mjd_t"
+"QttyQuantity" = "qtty_quantity_t"
+
+[enum]
+rename_variants = "ScreamingSnakeCase"
+prefix_with_name = true
+
+[fn]
+prefix = ""

package/tempoch-js/tempoch/tempoch-ffi/src/error.rs

@@ -0,0 +1,19 @@
+// SPDX-License-Identifier: AGPL-3.0-only
+
+/// Status codes returned by tempoch-ffi functions.
+///
+/// cbindgen:prefix-with-name
+#[repr(i32)]
+#[derive(Debug, Clone, Copy, PartialEq, Eq)]
+pub enum TempochStatus {
+    /// Success.
+    Ok = 0,
+    /// A required output pointer was null.
+    NullPointer = 1,
+    /// UTC conversion failed (date out of range or invalid).
+    UtcConversionFailed = 2,
+    /// The period is invalid (start > end).
+    InvalidPeriod = 3,
+    /// The two periods do not intersect.
+    NoIntersection = 4,
+}

package/tempoch-js/tempoch/tempoch-ffi/src/lib.rs

@@ -0,0 +1,82 @@
+// SPDX-License-Identifier: AGPL-3.0-only
+// Copyright (C) 2026 Vallés Puig, Ramon
+
+//! C FFI bindings for **tempoch** — astronomical time primitives.
+//!
+//! This crate exposes a flat C-compatible API for creating and manipulating
+//! Julian Dates, Modified Julian Dates, time periods, and UTC conversions.
+//!
+//! Duration-related functions return [`QttyQuantity`] from qtty-ffi, providing
+//! type-safe unit information alongside numeric values.
+
+#![deny(missing_docs)]
+#![deny(unsafe_op_in_unsafe_fn)]
+
+mod error;
+mod period;
+mod time;
+
+pub use error::*;
+pub use period::*;
+pub use time::*;
+
+// Re-export qtty-ffi types used in our public FFI surface
+pub use qtty_ffi::{QttyQuantity, UnitId};
+
+/// Catches any panic and returns an error value instead of unwinding across FFI.
+macro_rules! catch_panic {
+    ($default:expr, $body:expr) => {{
+        match std::panic::catch_unwind(std::panic::AssertUnwindSafe(|| $body)) {
+            Ok(result) => result,
+            Err(_) => $default,
+        }
+    }};
+}
+pub(crate) use catch_panic;
+
+/// Returns the tempoch-ffi ABI version (semver-encoded: major*10000 + minor*100 + patch).
+#[allow(clippy::erasing_op, clippy::identity_op)]
+#[no_mangle]
+pub extern "C" fn tempoch_ffi_version() -> u32 {
+    0 * 10000 + 1 * 100 + 0 // 0.1.0
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    #[test]
+    fn version_returns_expected_value() {
+        assert_eq!(tempoch_ffi_version(), 100);
+    }
+
+    // ── Layout tests ─────────────────────────────────────────────────
+    // These tests guard ABI stability by asserting exact sizes and
+    // alignments of every `#[repr(C)]`/`#[repr(i32)]` type.
+
+    #[test]
+    fn layout_tempoch_status() {
+        assert_eq!(std::mem::size_of::<TempochStatus>(), 4);
+        assert_eq!(std::mem::align_of::<TempochStatus>(), 4);
+    }
+
+    #[test]
+    fn layout_tempoch_scale() {
+        assert_eq!(std::mem::size_of::<TempochScale>(), 4);
+        assert_eq!(std::mem::align_of::<TempochScale>(), 4);
+    }
+
+    #[test]
+    fn layout_tempoch_utc() {
+        // i32 + u8*5 + padding + u32 = 16 with C repr packing
+        assert_eq!(std::mem::size_of::<TempochUtc>(), 16);
+        assert_eq!(std::mem::align_of::<TempochUtc>(), 4);
+    }
+
+    #[test]
+    fn layout_tempoch_period_mjd() {
+        // Two f64 fields → 16 bytes, 8-aligned
+        assert_eq!(std::mem::size_of::<TempochPeriodMjd>(), 16);
+        assert_eq!(std::mem::align_of::<TempochPeriodMjd>(), 8);
+    }
+}

package/tempoch-js/tempoch/tempoch-ffi/src/period.rs

@@ -0,0 +1,101 @@
+// SPDX-License-Identifier: AGPL-3.0-only
+// Copyright (C) 2026 Vallés Puig, Ramon
+
+//! FFI bindings for tempoch period/interval types.
+
+use crate::catch_panic;
+use crate::error::TempochStatus;
+use tempoch::{Interval, ModifiedJulianDate, Period, MJD};
+
+// ═══════════════════════════════════════════════════════════════════════════
+// C-repr types
+// ═══════════════════════════════════════════════════════════════════════════
+
+/// A time period in Modified Julian Date, suitable for C interop.
+#[repr(C)]
+#[derive(Debug, Clone, Copy)]
+pub struct TempochPeriodMjd {
+    /// Start of the period (MJD).
+    pub start_mjd: f64,
+    /// End of the period (MJD).
+    pub end_mjd: f64,
+}
+
+impl TempochPeriodMjd {
+    /// Convert from Rust `Period<MJD>` to the C-repr struct.
+    pub fn from_period(p: &Period<MJD>) -> Self {
+        Self {
+            start_mjd: p.start.value(),
+            end_mjd: p.end.value(),
+        }
+    }
+
+    /// Convert to Rust `Period<MJD>`.
+    pub fn to_period(&self) -> Period<MJD> {
+        Interval::new(
+            ModifiedJulianDate::new(self.start_mjd),
+            ModifiedJulianDate::new(self.end_mjd),
+        )
+    }
+}
+
+// ═══════════════════════════════════════════════════════════════════════════
+// Period functions
+// ═══════════════════════════════════════════════════════════════════════════
+
+/// Create a new MJD period. Returns InvalidPeriod if start > end.
+///
+/// # Safety
+/// `out` must be a valid, writable pointer to `TempochPeriodMjd`.
+#[no_mangle]
+pub unsafe extern "C" fn tempoch_period_mjd_new(
+    start_mjd: f64,
+    end_mjd: f64,
+    out: *mut TempochPeriodMjd,
+) -> TempochStatus {
+    catch_panic!(TempochStatus::InvalidPeriod, {
+        if out.is_null() {
+            return TempochStatus::NullPointer;
+        }
+        if start_mjd > end_mjd {
+            return TempochStatus::InvalidPeriod;
+        }
+        unsafe {
+            *out = TempochPeriodMjd { start_mjd, end_mjd };
+        }
+        TempochStatus::Ok
+    })
+}
+
+/// Compute the duration of a period in days.
+#[no_mangle]
+pub extern "C" fn tempoch_period_mjd_duration_days(period: TempochPeriodMjd) -> f64 {
+    period.end_mjd - period.start_mjd
+}
+
+/// Compute the intersection of two periods.
+/// Returns NoIntersection if they don't overlap, Ok if `out` is filled.
+///
+/// # Safety
+/// `out` must be a valid, writable pointer to `TempochPeriodMjd`.
+#[no_mangle]
+pub unsafe extern "C" fn tempoch_period_mjd_intersection(
+    a: TempochPeriodMjd,
+    b: TempochPeriodMjd,
+    out: *mut TempochPeriodMjd,
+) -> TempochStatus {
+    catch_panic!(TempochStatus::NoIntersection, {
+        if out.is_null() {
+            return TempochStatus::NullPointer;
+        }
+        let pa = a.to_period();
+        let pb = b.to_period();
+        match pa.intersection(&pb) {
+            Some(result) => {
+                unsafe { *out = TempochPeriodMjd::from_period(&result) };
+                TempochStatus::Ok
+            }
+            None => TempochStatus::NoIntersection,
+        }
+    })
+}