Add timer_current_split_index

Author: AlexKnauth

crates/livesplit-auto-splitting/README.md

@@ -110,6 +110,12 @@ unsafe extern "C" {
     pub safe fn timer_undo_split();
     /// Resets the timer.
     pub safe fn timer_reset();
+    /// Accesses the index of the split the attempt is currently on. If there's
+    /// no attempt in progress, `-1` is returned instead. This returns an
+    /// index that is equal to the amount of segments when the attempt is
+    /// finished, but has not been reset. So you need to be careful when using
+    /// this value for indexing.
+    pub safe fn timer_current_split_index() -> i32;
     /// Sets a custom key value pair. This may be arbitrary information that the
     /// auto splitter wants to provide for visualization. The pointers need to
     /// point to valid UTF-8 encoded text with the respective given length.

crates/livesplit-auto-splitting/src/lib.rs

@@ -110,6 +110,12 @@
 //!     pub safe fn timer_undo_split();
 //!     /// Resets the timer.
 //!     pub safe fn timer_reset();
+//!     /// Accesses the index of the split the attempt is currently on. If there's
+//!     /// no attempt in progress, `-1` is returned instead. This returns an
+//!     /// index that is equal to the amount of segments when the attempt is
+//!     /// finished, but has not been reset. So you need to be careful when using
+//!     /// this value for indexing.
+//!     pub safe fn timer_current_split_index() -> i32;
 //!     /// Sets a custom key value pair. This may be arbitrary information that the
 //!     /// auto splitter wants to provide for visualization. The pointers need to
 //!     /// point to valid UTF-8 encoded text with the respective given length.

crates/livesplit-auto-splitting/src/runtime/api/timer.rs

@@ -69,6 +69,19 @@ pub fn bind<T: Timer>(linker: &mut Linker<Context<T>>) -> Result<(), CreationErr
             source,
             name: "timer_reset",
         })?
+        .func_wrap("env", "timer_current_split_index", {
+            |caller: Caller<'_, Context<T>>| {
+                caller
+                    .data()
+                    .timer
+                    .current_split_index()
+                    .map_or(-1, |i| i as i32)
+            }
+        })
+        .map_err(|source| CreationError::LinkFunction {
+            source,
+            name: "timer_current_split_index",
+        })?
         .func_wrap("env", "timer_set_variable", {
             |mut caller: Caller<'_, Context<T>>,
              name_ptr: u32,

src/auto_splitting/mod.rs

@@ -110,6 +110,12 @@
 //!     pub safe fn timer_undo_split();
 //!     /// Resets the timer.
 //!     pub safe fn timer_reset();
+//!     /// Accesses the index of the split the attempt is currently on. If there's
+//!     /// no attempt in progress, `-1` is returned instead. This returns an
+//!     /// index that is equal to the amount of segments when the attempt is
+//!     /// finished, but has not been reset. So you need to be careful when using
+//!     /// this value for indexing.
+//!     pub safe fn timer_current_split_index() -> i32;
 //!     /// Sets a custom key value pair. This may be arbitrary information that the
 //!     /// auto splitter wants to provide for visualization. The pointers need to
 //!     /// point to valid UTF-8 encoded text with the respective given length.