rubydex 0.1.0.beta1-x86_64-linux → 0.1.0.beta2-x86_64-linux

data/rust/rubydex-sys/src/reference_api.rs

@@ -0,0 +1,191 @@
+//! C API for exposing references through ID handles (like definitions)
+
+use std::ffi::CString;
+
+use crate::graph_api::{GraphPointer, with_graph};
+use crate::location_api::{Location, create_location_for_uri_and_offset};
+use libc::c_char;
+use rubydex::model::ids::ReferenceId;
+
+/// Kind of reference for FFI dispatch
+#[repr(C)]
+#[derive(Copy, Clone, Debug, PartialEq, Eq)]
+pub enum ReferenceKind {
+    Constant = 0,
+    Method = 1,
+}
+
+/// Shared iterator over reference (id, kind) pairs
+#[derive(Debug)]
+pub struct ReferencesIter {
+    pub entries: Box<[(i64, ReferenceKind)]>,
+    pub index: usize,
+}
+
+impl ReferencesIter {
+    #[must_use]
+    pub fn new(entries: Box<[(i64, ReferenceKind)]>) -> *mut ReferencesIter {
+        Box::into_raw(Box::new(ReferencesIter { entries, index: 0 }))
+    }
+}
+
+/// Returns the total number of entries in the iterator snapshot.
+///
+/// # Safety
+/// - `iter` must be a valid pointer previously returned by `ReferencesIter::new`.
+#[unsafe(no_mangle)]
+pub unsafe extern "C" fn rdx_references_iter_len(iter: *const ReferencesIter) -> usize {
+    if iter.is_null() {
+        return 0;
+    }
+    unsafe { (&*iter).entries.len() }
+}
+
+/// Advances the iterator and writes the next entry into the provided out params.
+/// Returns `true` if an entry was written, or `false` if the iterator is exhausted or inputs are invalid.
+///
+/// # Safety
+/// - `iter` must be a valid pointer previously returned by `ReferencesIter::new`.
+/// - `out_id` and `out_kind` must be valid, writable pointers.
+///
+/// # Panics
+/// - If the iterator is exhausted or inputs are invalid.
+/// - If the name, URI, start, or end pointers are invalid.
+#[unsafe(no_mangle)]
+pub unsafe extern "C" fn rdx_references_iter_next(
+    iter: *mut ReferencesIter,
+    out_id: *mut i64,
+    out_kind: *mut ReferenceKind,
+) -> bool {
+    if iter.is_null() || out_id.is_null() || out_kind.is_null() {
+        return false;
+    }
+
+    let it = unsafe { &mut *iter };
+    if it.index >= it.entries.len() {
+        return false;
+    }
+
+    let (id, kind) = it.entries[it.index];
+    it.index += 1;
+    unsafe {
+        *out_id = id;
+        *out_kind = kind;
+    }
+    true
+}
+
+/// Frees an iterator created by `ReferencesIter::new`.
+///
+/// # Safety
+/// - `iter` must be a pointer previously returned by `ReferencesIter::new`.
+/// - `iter` must not be used after being freed.
+#[unsafe(no_mangle)]
+pub unsafe extern "C" fn rdx_references_iter_free(iter: *mut ReferencesIter) {
+    if iter.is_null() {
+        return;
+    }
+    unsafe {
+        let _ = Box::from_raw(iter);
+    }
+}
+
+/// Returns the UTF-8 name string for a constant reference id.
+/// Caller must free with `free_c_string`.
+///
+/// # Safety
+///
+/// Assumes pointer is valid.
+///
+/// # Panics
+///
+/// This function will panic if the reference cannot be found.
+#[unsafe(no_mangle)]
+pub unsafe extern "C" fn rdx_constant_reference_name(pointer: GraphPointer, reference_id: i64) -> *const c_char {
+    with_graph(pointer, |graph| {
+        let ref_id = ReferenceId::new(reference_id);
+        let reference = graph.constant_references().get(&ref_id).expect("Reference not found");
+        let name = graph.names().get(reference.name_id()).expect("Name ID should exist");
+
+        let name_string = graph
+            .strings()
+            .get(name.str())
+            .expect("String ID should exist")
+            .to_string();
+        CString::new(name_string).unwrap().into_raw().cast_const()
+    })
+}
+
+/// Returns the UTF-8 name string for a method reference id.
+/// Caller must free with `free_c_string`.
+///
+/// # Safety
+///
+/// Assumes pointer is valid.
+///
+/// # Panics
+///
+/// This function will panic if the reference cannot be found.
+#[unsafe(no_mangle)]
+pub unsafe extern "C" fn rdx_method_reference_name(pointer: GraphPointer, reference_id: i64) -> *const c_char {
+    with_graph(pointer, |graph| {
+        let ref_id = ReferenceId::new(reference_id);
+        let reference = graph.method_references().get(&ref_id).expect("Reference not found");
+        let name = graph
+            .strings()
+            .get(reference.str())
+            .expect("Name ID should exist")
+            .to_string();
+        CString::new(name).unwrap().into_raw().cast_const()
+    })
+}
+
+/// Returns a newly allocated `Location` for the given constant reference id.
+/// Caller must free the returned pointer with `rdx_location_free`.
+///
+/// # Safety
+///
+/// - `pointer` must be a valid pointer previously returned by `rdx_graph_new`.
+/// - `reference_id` must be a valid reference id.
+///
+/// # Panics
+///
+/// This function will panic if a reference or document cannot be found.
+#[unsafe(no_mangle)]
+pub unsafe extern "C" fn rdx_constant_reference_location(pointer: GraphPointer, reference_id: i64) -> *mut Location {
+    with_graph(pointer, |graph| {
+        let ref_id = ReferenceId::new(reference_id);
+        let reference = graph.constant_references().get(&ref_id).expect("Reference not found");
+        let document = graph
+            .documents()
+            .get(&reference.uri_id())
+            .expect("Document should exist");
+
+        create_location_for_uri_and_offset(graph, document, reference.offset())
+    })
+}
+
+/// Returns a newly allocated `Location` for the given method reference id.
+/// Caller must free the returned pointer with `rdx_location_free`.
+///
+/// # Safety
+///
+/// - `pointer` must be a valid pointer previously returned by `rdx_graph_new`.
+/// - `reference_id` must be a valid reference id.
+///
+/// # Panics
+///
+/// This function will panic if a reference or document cannot be found.
+#[unsafe(no_mangle)]
+pub unsafe extern "C" fn rdx_method_reference_location(pointer: GraphPointer, reference_id: i64) -> *mut Location {
+    with_graph(pointer, |graph| {
+        let ref_id = ReferenceId::new(reference_id);
+        let reference = graph.method_references().get(&ref_id).expect("Reference not found");
+        let document = graph
+            .documents()
+            .get(&reference.uri_id())
+            .expect("Document should exist");
+
+        create_location_for_uri_and_offset(graph, document, reference.offset())
+    })
+}

data/rust/rubydex-sys/src/utils.rs

@@ -0,0 +1,50 @@
+use libc::{c_char, size_t};
+use std::ffi::{CStr, CString};
+use std::slice;
+use std::str::Utf8Error;
+
+/// Converts a C array of strings into a Vec<String>
+///
+/// # Safety
+///
+/// This function is unsafe because it attempts to instantiate a Vec<String> from a raw char** pointer
+///
+/// # Errors
+///
+/// This function errors if any of the strings inside the array contain invalid UTF-8 data
+pub unsafe fn convert_double_pointer_to_vec(data: *const *const c_char, len: size_t) -> Result<Vec<String>, Utf8Error> {
+    unsafe {
+        slice::from_raw_parts(data, len)
+            .iter()
+            .map(|arg| CStr::from_ptr(*arg).to_str().map(ToString::to_string))
+            .collect()
+    }
+}
+
+/// # Safety
+///
+/// This function is unsafe because it dereferences the char pointer, which needs to be valid for the duration of the
+/// function
+///
+/// # Errors
+///
+/// This function errors if any of the strings inside the array contain invalid UTF-8 data
+pub unsafe fn convert_char_ptr_to_string(data: *const c_char) -> Result<String, Utf8Error> {
+    unsafe { CStr::from_ptr(data).to_str().map(ToString::to_string) }
+}
+
+/// Frees a `CString` allocated on the Rust side
+#[unsafe(no_mangle)]
+pub extern "C" fn free_c_string(ptr: *const c_char) {
+    unsafe {
+        let _ = CString::from_raw(ptr.cast_mut());
+    }
+}
+
+/// Frees a boxed i64 allocated on the Rust side
+#[unsafe(no_mangle)]
+pub extern "C" fn free_i64(ptr: *const i64) {
+    unsafe {
+        let _ = Box::from_raw(ptr.cast_mut());
+    }
+}

data/rust/rustfmt.toml

@@ -0,0 +1,2 @@
+max_width = 120
+edition = "2024"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubydex
 version: !ruby/object:Gem::Version
-  version: 0.1.0.beta1
+  version: 0.1.0.beta2
 platform: x86_64-linux
 authors:
 - Shopify
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2026-01-21 00:00:00.000000000 Z
+date: 2026-01-22 00:00:00.000000000 Z
 dependencies: []
 description: A high performance static analysis suite for Ruby, built in Rust with
   Ruby APIs
@@ -23,7 +23,25 @@ files:
 - README.md
 - THIRD_PARTY_LICENSES.html
 - exe/rdx
+- ext/rubydex/declaration.c
+- ext/rubydex/declaration.h
+- ext/rubydex/definition.c
+- ext/rubydex/definition.h
+- ext/rubydex/diagnostic.c
+- ext/rubydex/diagnostic.h
+- ext/rubydex/document.c
+- ext/rubydex/document.h
 - ext/rubydex/extconf.rb
+- ext/rubydex/graph.c
+- ext/rubydex/graph.h
+- ext/rubydex/handle.h
+- ext/rubydex/location.c
+- ext/rubydex/location.h
+- ext/rubydex/reference.c
+- ext/rubydex/reference.h
+- ext/rubydex/rubydex.c
+- ext/rubydex/utils.c
+- ext/rubydex/utils.h
 - lib/rubydex.rb
 - lib/rubydex/3.2/rubydex.so
 - lib/rubydex/3.3/rubydex.so
@@ -32,8 +50,65 @@ files:
 - lib/rubydex/comment.rb
 - lib/rubydex/diagnostic.rb
 - lib/rubydex/graph.rb
+- lib/rubydex/librubydex_sys.so
 - lib/rubydex/location.rb
 - lib/rubydex/version.rb
+- rust/Cargo.lock
+- rust/Cargo.toml
+- rust/about.hbs
+- rust/about.toml
+- rust/rubydex-sys/Cargo.toml
+- rust/rubydex-sys/build.rs
+- rust/rubydex-sys/cbindgen.toml
+- rust/rubydex-sys/src/declaration_api.rs
+- rust/rubydex-sys/src/definition_api.rs
+- rust/rubydex-sys/src/diagnostic_api.rs
+- rust/rubydex-sys/src/document_api.rs
+- rust/rubydex-sys/src/graph_api.rs
+- rust/rubydex-sys/src/lib.rs
+- rust/rubydex-sys/src/location_api.rs
+- rust/rubydex-sys/src/name_api.rs
+- rust/rubydex-sys/src/reference_api.rs
+- rust/rubydex-sys/src/utils.rs
+- rust/rubydex/Cargo.toml
+- rust/rubydex/src/diagnostic.rs
+- rust/rubydex/src/errors.rs
+- rust/rubydex/src/indexing.rs
+- rust/rubydex/src/indexing/local_graph.rs
+- rust/rubydex/src/indexing/ruby_indexer.rs
+- rust/rubydex/src/job_queue.rs
+- rust/rubydex/src/lib.rs
+- rust/rubydex/src/listing.rs
+- rust/rubydex/src/main.rs
+- rust/rubydex/src/model.rs
+- rust/rubydex/src/model/comment.rs
+- rust/rubydex/src/model/declaration.rs
+- rust/rubydex/src/model/definitions.rs
+- rust/rubydex/src/model/document.rs
+- rust/rubydex/src/model/encoding.rs
+- rust/rubydex/src/model/graph.rs
+- rust/rubydex/src/model/id.rs
+- rust/rubydex/src/model/identity_maps.rs
+- rust/rubydex/src/model/ids.rs
+- rust/rubydex/src/model/name.rs
+- rust/rubydex/src/model/references.rs
+- rust/rubydex/src/model/string_ref.rs
+- rust/rubydex/src/model/visibility.rs
+- rust/rubydex/src/offset.rs
+- rust/rubydex/src/position.rs
+- rust/rubydex/src/query.rs
+- rust/rubydex/src/resolution.rs
+- rust/rubydex/src/stats.rs
+- rust/rubydex/src/stats/memory.rs
+- rust/rubydex/src/stats/timer.rs
+- rust/rubydex/src/test_utils.rs
+- rust/rubydex/src/test_utils/context.rs
+- rust/rubydex/src/test_utils/graph_test.rs
+- rust/rubydex/src/test_utils/local_graph_test.rs
+- rust/rubydex/src/visualization.rs
+- rust/rubydex/src/visualization/dot.rs
+- rust/rubydex/tests/cli.rs
+- rust/rustfmt.toml
 homepage: https://github.com/Shopify/rubydex
 licenses:
 - MIT