rubydex 0.2.6 → 0.2.7

data/ext/rubydex/definition.c

@@ -7,6 +7,12 @@
 #include "signature.h"
 #include "ruby/internal/scan_args.h"
 #include "rustbindings.h"
+#include "utils.h"
+
+/*
+ * RDoc parser workaround for https://github.com/ruby/rdoc/issues/1744:
+ * mRubydex = rb_define_module("Rubydex")
+ */
 
 static VALUE mRubydex;
 static VALUE cInclude;
@@ -71,13 +77,15 @@ VALUE rdxi_definition_class_for_kind(DefinitionKind kind) {
     }
 }
 
-// Definition#location -> Rubydex::Location
+/*
+ * call-seq:
+ *   location -> Rubydex::Location
+ *
+ * Returns the source location for this definition.
+ */
 static VALUE rdxr_definition_location(VALUE self) {
     HandleData *data;
-    TypedData_Get_Struct(self, HandleData, &handle_type, data);
-
-    void *graph;
-    TypedData_Get_Struct(data->graph_obj, void *, &graph_type, graph);
+    void *graph = rdxi_graph_from_handle(self, &data);
 
     Location *loc = rdx_definition_location(graph, data->id);
     VALUE location = rdxi_build_location_value(loc);
@@ -86,13 +94,15 @@ static VALUE rdxr_definition_location(VALUE self) {
     return location;
 }
 
-// Definition#comments -> [Rubydex::Comment]
+/*
+ * call-seq:
+ *   comments -> Array[Rubydex::Comment]
+ *
+ * Returns the source comments associated with this definition.
+ */
 static VALUE rdxr_definition_comments(VALUE self) {
     HandleData *data;
-    TypedData_Get_Struct(self, HandleData, &handle_type, data);
-
-    void *graph;
-    TypedData_Get_Struct(data->graph_obj, void *, &graph_type, graph);
+    void *graph = rdxi_graph_from_handle(self, &data);
 
     CommentArray *arr = rdx_definition_comments(graph, data->id);
     if (arr == NULL || arr->len == 0) {
@@ -124,44 +134,44 @@ static VALUE rdxr_definition_comments(VALUE self) {
     return ary;
 }
 
-// Definition#name -> String
+/*
+ * call-seq:
+ *   name -> String?
+ *
+ * Returns the definition name.
+ */
 static VALUE rdxr_definition_name(VALUE self) {
     HandleData *data;
-    TypedData_Get_Struct(self, HandleData, &handle_type, data);
-
-    void *graph;
-    TypedData_Get_Struct(data->graph_obj, void *, &graph_type, graph);
+    void *graph = rdxi_graph_from_handle(self, &data);
 
     const char *name = rdx_definition_name(graph, data->id);
-    if (name == NULL) {
-        return Qnil;
-    }
-    VALUE str = rb_utf8_str_new_cstr(name);
-    free_c_string(name);
-    return str;
+    return rdxi_owned_c_string_to_ruby(name);
 }
 
-// Definition#deprecated? -> bool
+/*
+ * call-seq:
+ *   deprecated? -> bool
+ *
+ * Returns whether this definition is marked as deprecated.
+ */
 static VALUE rdxr_definition_deprecated(VALUE self) {
     HandleData *data;
-    TypedData_Get_Struct(self, HandleData, &handle_type, data);
-
-    void *graph;
-    TypedData_Get_Struct(data->graph_obj, void *, &graph_type, graph);
+    void *graph = rdxi_graph_from_handle(self, &data);
 
     bool deprecated = rdx_definition_is_deprecated(graph, data->id);
     return deprecated ? Qtrue : Qfalse;
 }
 
-// Definition#name_location -> Rubydex::Location or nil
-// For class, module, singleton class, and method definitions, returns the location of just the name
-// (e.g., "Bar" in "class Foo::Bar", or "foo" in "def foo"). For other definition types, returns nil.
+/*
+ * call-seq:
+ *   name_location -> Rubydex::Location?
+ *
+ * For class, module, singleton class, and method definitions, returns the location of just the name, such as "Bar" in
+ * "class Foo::Bar" or "foo" in "def foo". For other definition types, returns nil.
+ */
 static VALUE rdxr_definition_name_location(VALUE self) {
     HandleData *data;
-    TypedData_Get_Struct(self, HandleData, &handle_type, data);
-
-    void *graph;
-    TypedData_Get_Struct(data->graph_obj, void *, &graph_type, graph);
+    void *graph = rdxi_graph_from_handle(self, &data);
 
     Location *loc = rdx_definition_name_location(graph, data->id);
     if (loc == NULL) {
@@ -173,15 +183,15 @@ static VALUE rdxr_definition_name_location(VALUE self) {
     return location;
 }
 
-// Definition#declaration -> Rubydex::Declaration?
-// Returns the declaration this definition belongs to or nil when it cannot be located (for example, before
-// `Graph#resolve` has run).
+/*
+ * call-seq:
+ *   declaration -> Rubydex::Declaration?
+ *
+ * Returns the declaration this definition belongs to or nil when it cannot be located.
+ */
 static VALUE rdxr_definition_declaration(VALUE self) {
     HandleData *data;
-    TypedData_Get_Struct(self, HandleData, &handle_type, data);
-
-    void *graph;
-    TypedData_Get_Struct(data->graph_obj, void *, &graph_type, graph);
+    void *graph = rdxi_graph_from_handle(self, &data);
 
     const struct CDeclaration *decl = rdx_definition_declaration(graph, data->id);
     if (decl == NULL) {
@@ -203,14 +213,15 @@ static VALUE rdxi_build_definition(VALUE graph_obj, void *graph, uint64_t defini
     return rb_class_new_instance(2, argv, defn_class);
 }
 
-// Definition#lexical_owner -> Rubydex::Definition?
-// Returns the lexically enclosing definition, if any.
+/*
+ * call-seq:
+ *   lexical_owner -> Rubydex::Definition?
+ *
+ * Returns the lexically enclosing definition, if any.
+ */
 static VALUE rdxr_definition_lexical_owner(VALUE self) {
     HandleData *data;
-    TypedData_Get_Struct(self, HandleData, &handle_type, data);
-
-    void *graph;
-    TypedData_Get_Struct(data->graph_obj, void *, &graph_type, graph);
+    void *graph = rdxi_graph_from_handle(self, &data);
 
     const uint64_t *owner_id = rdx_definition_lexical_nesting_id(graph, data->id);
     if (owner_id == NULL) {
@@ -223,14 +234,15 @@ static VALUE rdxr_definition_lexical_owner(VALUE self) {
     return owner;
 }
 
-// Definition#lexical_nesting -> Array<Rubydex::Definition>
-// Returns the lexical nesting from the direct owner up to the root.
+/*
+ * call-seq:
+ *   lexical_nesting -> Array[Rubydex::Definition]
+ *
+ * Returns the lexical nesting from the direct owner up to the root.
+ */
 static VALUE rdxr_definition_lexical_nesting(VALUE self) {
     HandleData *data;
-    TypedData_Get_Struct(self, HandleData, &handle_type, data);
-
-    void *graph;
-    TypedData_Get_Struct(data->graph_obj, void *, &graph_type, graph);
+    void *graph = rdxi_graph_from_handle(self, &data);
 
     VALUE nesting = rb_ary_new();
     uint64_t definition_id = data->id;
@@ -258,13 +270,15 @@ static VALUE rdxi_build_constant_reference(VALUE graph_obj, const CConstantRefer
     return rb_class_new_instance(2, argv, ref_class);
 }
 
-// ClassDefinition#superclass -> ConstantReference?
+/*
+ * call-seq:
+ *   superclass -> Rubydex::ConstantReference?
+ *
+ * Returns the superclass constant reference, or nil if this class definition has no explicit superclass.
+ */
 static VALUE rdxr_class_definition_superclass(VALUE self) {
     HandleData *data;
-    TypedData_Get_Struct(self, HandleData, &handle_type, data);
-
-    void *graph;
-    TypedData_Get_Struct(data->graph_obj, void *, &graph_type, graph);
+    void *graph = rdxi_graph_from_handle(self, &data);
 
     const CConstantReference *ref = rdx_class_definition_superclass(graph, data->id);
     if (ref == NULL) {
@@ -289,13 +303,15 @@ static VALUE rdxi_mixin_class_for_kind(MixinKind kind) {
     }
 }
 
-// Definition#mixins -> [Rubydex::Mixin]
+/*
+ * call-seq:
+ *   mixins -> Array[Rubydex::Mixin]
+ *
+ * Returns mixins attached to this definition.
+ */
 static VALUE rdxr_definition_mixins(VALUE self) {
     HandleData *data;
-    TypedData_Get_Struct(self, HandleData, &handle_type, data);
-
-    void *graph;
-    TypedData_Get_Struct(data->graph_obj, void *, &graph_type, graph);
+    void *graph = rdxi_graph_from_handle(self, &data);
 
     MixinsIter *iter = rdx_definition_mixins(graph, data->id);
     if (iter == NULL) {
@@ -317,40 +333,44 @@ static VALUE rdxr_definition_mixins(VALUE self) {
     return ary;
 }
 
-// MethodDefinition#signatures -> [Rubydex::Signature]
+/*
+ * call-seq:
+ *   signatures -> Array[Rubydex::Signature]
+ *
+ * Returns signatures for this method definition.
+ */
 static VALUE rdxr_method_definition_signatures(VALUE self) {
     HandleData *data;
-    TypedData_Get_Struct(self, HandleData, &handle_type, data);
-
-    void *graph;
-    TypedData_Get_Struct(data->graph_obj, void *, &graph_type, graph);
+    void *graph = rdxi_graph_from_handle(self, &data);
 
     SignatureArray *arr = rdx_definition_signatures(graph, data->id);
     return rdxi_signatures_to_ruby(arr);
 }
 
-// MethodAliasDefinition#signatures -> [Rubydex::Signature]
+/*
+ * call-seq:
+ *   signatures -> Array[Rubydex::Signature]
+ *
+ * Returns signatures for this method alias definition.
+ */
 static VALUE rdxr_method_alias_definition_signatures(VALUE self) {
     HandleData *data;
-    TypedData_Get_Struct(self, HandleData, &handle_type, data);
-
-    void *graph;
-    TypedData_Get_Struct(data->graph_obj, void *, &graph_type, graph);
+    void *graph = rdxi_graph_from_handle(self, &data);
 
     SignatureArray *arr = rdx_method_alias_definition_signatures(graph, data->id);
     return rdxi_signatures_to_ruby(arr);
 }
 
-// MethodAliasDefinition#target -> Rubydex::Method?
-// Returns the resolved target method declaration by following the alias chain, or nil if the chain could not be
-// resolved (the target name doesn't exist on the owner, or the owner itself never resolved). Raises
-// Rubydex::AliasCycleError when the alias chain forms a cycle.
+/*
+ * call-seq:
+ *   target -> Rubydex::Method?
+ *
+ * Returns the resolved target method declaration by following the alias chain, or nil if the chain could not be
+ * resolved. Raises Rubydex::AliasCycleError when the alias chain forms a cycle.
+ */
 static VALUE rdxr_method_alias_definition_target(VALUE self) {
     HandleData *data;
-    TypedData_Get_Struct(self, HandleData, &handle_type, data);
-
-    void *graph;
-    TypedData_Get_Struct(data->graph_obj, void *, &graph_type, graph);
+    void *graph = rdxi_graph_from_handle(self, &data);
 
     CMethodAliasTargetResult result = rdx_method_alias_definition_target(graph, data->id);
 

data/ext/rubydex/diagnostic.c

@@ -1,6 +1,11 @@
 #include "diagnostic.h"
 #include "rustbindings.h"
 
+/*
+ * RDoc parser workaround for https://github.com/ruby/rdoc/issues/1744:
+ * mRubydex = rb_define_module("Rubydex")
+ */
+
 VALUE cDiagnostic;
 
 void rdxi_initialize_diagnostic(VALUE mRubydex) { cDiagnostic = rb_define_class_under(mRubydex, "Diagnostic", rb_cObject); }

data/ext/rubydex/document.c

@@ -5,25 +5,25 @@
 #include "rustbindings.h"
 #include "utils.h"
 
+/*
+ * RDoc parser workaround for https://github.com/ruby/rdoc/issues/1744:
+ * mRubydex = rb_define_module("Rubydex")
+ */
+
 VALUE cDocument;
 
-// Document#uri -> String
+/*
+ * call-seq:
+ *   uri -> String?
+ *
+ * Returns the document URI.
+ */
 static VALUE rdxr_document_uri(VALUE self) {
     HandleData *data;
-    TypedData_Get_Struct(self, HandleData, &handle_type, data);
-
-    void *graph;
-    TypedData_Get_Struct(data->graph_obj, void *, &graph_type, graph);
+    void *graph = rdxi_graph_from_handle(self, &data);
     const char *uri = rdx_document_uri(graph, data->id);
 
-    if (uri == NULL) {
-        return Qnil;
-    }
-
-    VALUE str = rb_utf8_str_new_cstr(uri);
-    free_c_string(uri);
-
-    return str;
+    return rdxi_owned_c_string_to_ruby(uri);
 }
 
 // Body function for rb_ensure in Document#definitions
@@ -56,10 +56,7 @@ static VALUE document_definitions_ensure(VALUE args) {
 // Size function for the Document#definitions enumerator
 static VALUE document_definitions_size(VALUE self, VALUE _args, VALUE _eobj) {
     HandleData *data;
-    TypedData_Get_Struct(self, HandleData, &handle_type, data);
-
-    void *graph;
-    TypedData_Get_Struct(data->graph_obj, void *, &graph_type, graph);
+    void *graph = rdxi_graph_from_handle(self, &data);
     struct DefinitionsIter *iter = rdx_document_definitions_iter_new(graph, data->id);
     size_t len = rdx_definitions_iter_len(iter);
     rdx_definitions_iter_free(iter);
@@ -67,18 +64,19 @@ static VALUE document_definitions_size(VALUE self, VALUE _args, VALUE _eobj) {
     return SIZET2NUM(len);
 }
 
-// Document#definitions: () -> Enumerator[Definition]
-// Returns an enumerator that yields all definitions for this document lazily
+/*
+ * call-seq:
+ *   definitions -> Enumerator[Rubydex::Definition]
+ *
+ * Returns an enumerator that yields all definitions for this document lazily.
+ */
 static VALUE rdxr_document_definitions(VALUE self) {
     if (!rb_block_given_p()) {
         return rb_enumeratorize_with_size(self, rb_str_new2("definitions"), 0, NULL, document_definitions_size);
     }
 
     HandleData *data;
-    TypedData_Get_Struct(self, HandleData, &handle_type, data);
-
-    void *graph;
-    TypedData_Get_Struct(data->graph_obj, void *, &graph_type, graph);
+    void *graph = rdxi_graph_from_handle(self, &data);
     void *iter = rdx_document_definitions_iter_new(graph, data->id);
     VALUE args = rb_ary_new_from_args(2, self, ULL2NUM((uintptr_t)iter));
     rb_ensure(document_definitions_yield, args, document_definitions_ensure, args);
@@ -89,10 +87,7 @@ static VALUE rdxr_document_definitions(VALUE self) {
 // Size function for the Document#method_references enumerator
 static VALUE document_method_references_size(VALUE self, VALUE _args, VALUE _eobj) {
     HandleData *data;
-    TypedData_Get_Struct(self, HandleData, &handle_type, data);
-
-    void *graph;
-    TypedData_Get_Struct(data->graph_obj, void *, &graph_type, graph);
+    void *graph = rdxi_graph_from_handle(self, &data);
     struct MethodReferencesIter *iter = rdx_document_method_references_iter_new(graph, data->id);
     size_t len = rdx_method_references_iter_len(iter);
     rdx_method_references_iter_free(iter);
@@ -109,10 +104,7 @@ static VALUE rdxr_document_method_references(VALUE self) {
     }
 
     HandleData *data;
-    TypedData_Get_Struct(self, HandleData, &handle_type, data);
-
-    void *graph;
-    TypedData_Get_Struct(data->graph_obj, void *, &graph_type, graph);
+    void *graph = rdxi_graph_from_handle(self, &data);
     void *iter = rdx_document_method_references_iter_new(graph, data->id);
     VALUE args = rb_ary_new_from_args(2, data->graph_obj, ULL2NUM((uintptr_t)iter));
     rb_ensure(rdxi_method_references_yield, args, rdxi_method_references_ensure, args);

data/ext/rubydex/extconf.rb

@@ -78,7 +78,7 @@ cargo_command = if ENV["SANITIZER"]
   ENV["RUSTFLAGS"] = "-Zsanitizer=#{ENV["SANITIZER"]}"
   "cargo +nightly build -Zbuild-std #{cargo_args.join(" ")}".strip
 else
-  "cargo build #{cargo_args.join(" ")}".strip
+  "cargo build --features rubydex/jemalloc_dylib #{cargo_args.join(" ")}".strip
 end
 
 lib_dir = gem_dir.join("lib").join("rubydex")