Merge pull request #281 from github/fully-qualified-name

Add `fully_qualified_name` field to `SourceInfo`

Author: Rick Winfrey

stack-graphs/CHANGELOG.md

@@ -11,6 +11,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - New `Defines` and `Refers` assertions test for the presence of definitions and references, respectively, without resolution.
 - A method `StackGraph::get_file` to look up an existing file.
+- A field named `fully_qualified_name` was added to `SourceInfo`.
 
 ### Changed
 

stack-graphs/include/stack-graphs.h

@@ -259,6 +259,9 @@ struct sg_source_info {
     // If you need one of these to make the type checker happy, but you don't have one, just use
     // sg_span::default(), as this will correspond to the all-0s spans which mean "no definiens".
     struct sg_span definiens_span;
+    // The fully qualified name is a representation of the symbol that captures its name and its
+    // embedded context (e.g. `foo.bar` for the symbol `bar` defined in the module `foo`).
+    sg_string_handle fully_qualified_name;
 };
 
 // An array of all of the source information in a stack graph.  Source information is associated

stack-graphs/src/c.rs

@@ -627,12 +627,14 @@ pub struct sg_source_info {
     pub syntax_type: sg_string_handle,
     /// The full content of the line containing this node in its source file.
     pub containing_line: sg_string_handle,
-
     /// The location in its containing file of the source code that this node's definiens represents.
     /// This is used for things like the bodies of functions, rather than the RHSes of equations.
     /// If you need one of these to make the type checker happy, but you don't have one, just use
     /// sg_span::default(), as this will correspond to the all-0s spans which mean "no definiens".
     pub definiens_span: sg_span,
+    /// The fully qualified name is a representation of the symbol that captures its name and its
+    /// embedded context (e.g. `foo.bar` for the symbol `bar` defined in the module `foo`).
+    pub fully_qualified_name: sg_string_handle,
 }
 
 /// All of the position information that we have about a range of content in a source file

stack-graphs/src/graph.rs

@@ -1337,14 +1337,17 @@ pub struct SourceInfo {
     /// The location in its containing file of the source code that this node represents.
     pub span: lsp_positions::Span,
     /// The kind of syntax entity this node represents (e.g. `function`, `class`, `method`, etc.).
-    pub syntax_type: Option<Handle<InternedString>>,
+    pub syntax_type: ControlledOption<Handle<InternedString>>,
     /// The full content of the line containing this node in its source file.
     pub containing_line: ControlledOption<Handle<InternedString>>,
     /// The location in its containing file of the source code that this node's definiens represents.
     /// This is used for things like the bodies of functions, rather than the RHSes of equations.
     /// If you need one of these to make the type checker happy, but you don't have one, just use
     /// lsp_positions::Span::default(), as this will correspond to the all-0s spans which mean "no definiens".
     pub definiens_span: lsp_positions::Span,
+    /// The fully qualified name is a representation of the symbol that captures its name and its
+    /// embedded context (e.g. `foo.bar` for the symbol `bar` defined in the module `foo`).
+    pub fully_qualified_name: ControlledOption<Handle<InternedString>>,
 }
 
 impl StackGraph {
@@ -1565,13 +1568,16 @@ impl StackGraph {
                         span: source_info.span.clone(),
                         syntax_type: source_info
                             .syntax_type
-                            .map(|st| self.add_string(&other[st])),
+                            .into_option()
+                            .map(|st| self.add_string(&other[st]))
+                            .into(),
                         containing_line: source_info
                             .containing_line
                             .into_option()
                             .map(|cl| self.add_string(&other[cl]))
                             .into(),
                         definiens_span: source_info.definiens_span.clone(),
+                        fully_qualified_name: ControlledOption::default(),
                     };
                 }
                 if let Some(debug_info) = other.node_debug_info(other_node) {

stack-graphs/src/serde/graph.rs

@@ -141,7 +141,8 @@ impl StackGraph {
                         syntax_type: source_info
                             .syntax_type
                             .as_ref()
-                            .map(|st| graph.add_string(&st)),
+                            .map(|st| graph.add_string(&st))
+                            .into(),
                         ..Default::default()
                     };
                 }
@@ -444,7 +445,7 @@ impl crate::graph::StackGraph {
     ) -> Option<SourceInfo> {
         self.source_info(handle).map(|info| SourceInfo {
             span: info.span.clone(),
-            syntax_type: info.syntax_type.map(|ty| self[ty].to_owned()),
+            syntax_type: info.syntax_type.into_option().map(|ty| self[ty].to_owned()),
         })
     }
 

stack-graphs/tests/it/c/nodes.rs

@@ -674,6 +674,7 @@ fn can_create_source_info() {
 
     let syntax_type = add_string(graph, "function");
     let containing_line = add_string(graph, "def foo():");
+    let fully_qualified_name = add_string(graph, "bar.foo");
 
     let mut infos = [sg_node_source_info {
         node: handles[1],
@@ -682,6 +683,7 @@ fn can_create_source_info() {
             syntax_type,
             containing_line,
             definiens_span: sg_span::default(),
+            fully_qualified_name,
         },
     }];
     infos[0].source_info.span.start.line = 17;

stack-graphs/tests/it/test_graphs/simple.rs

@@ -5,6 +5,7 @@
 // Please see the LICENSE-APACHE or LICENSE-MIT files in this distribution for license details.
 // ------------------------------------------------------------------------------------------------
 
+use controlled_option::ControlledOption;
 use lsp_positions::Offset;
 use lsp_positions::Position;
 use lsp_positions::Span;
@@ -77,6 +78,7 @@ pub fn new() -> StackGraph {
         syntax_type: str_var.into(),
         containing_line: str_line0.into(),
         definiens_span: Span::default(),
+        fully_qualified_name: ControlledOption::default(),
     };
     *graph.source_info_mut(ref_x) = SourceInfo {
         span: Span {
@@ -104,6 +106,7 @@ pub fn new() -> StackGraph {
         syntax_type: str_var.into(),
         containing_line: str_line1.into(),
         definiens_span: Span::default(),
+        fully_qualified_name: ControlledOption::default(),
     };
 
     let str_dsl_var = graph.add_string("dsl_var");