Merge pull request #8 from Sarrus1/feature/reference-provider

Feature/reference provider

.github/workflows/release.yml

@@ -12,12 +12,51 @@ jobs:
             fail-fast: false
             matrix:
                 include:
-                    - target: x86_64-pc-windows-gnu
+                    - os: windows-latest
+                      target: x86_64-pc-windows-msvc
+                      program: cargo
                       archive: zip
-                    - target: x86_64-unknown-linux-musl
+
+                    - os: windows-latest
+                      target: i686-pc-windows-msvc
+                      program: cargo
+                      archive: zip
+
+                    - os: windows-latest
+                      target: aarch64-pc-windows-msvc
+                      program: cargo
+                      archive: zip
+
+                    - os: macos-latest
+                      target: x86_64-apple-darwin
+                      program: cargo
+                      archive: zip
+
+                    - os: macos-latest
+                      target: aarch64-apple-darwin
+                      program: cargo
                       archive: zip
-                    - target: x86_64-apple-darwin
+
+                    - os: ubuntu-20.04
+                      target: x86_64-unknown-linux-gnu
+                      program: cargo
                       archive: zip
+
+                    - os: ubuntu-20.04
+                      target: aarch64-unknown-linux-gnu
+                      program: cross
+                      archive: zip
+
+                    - os: ubuntu-20.04
+                      target: armv7-unknown-linux-gnueabihf
+                      program: cross
+                      archive: zip
+
+                    - os: ubuntu-20.04
+                      target: x86_64-unknown-linux-musl
+                      program: cargo
+                      archive: zip
+
         steps:
             - uses: actions/checkout@master
             - name: Compile and release

CHANGELOG.md

@@ -1,6 +1,10 @@
 ## Release Notes
 
-## [0.3.2]
+## [0.4.0]
+
+### Added
+
+-   Add Reference provider.
 
 ### Fixed
 

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "sourcepawn_lsp"
-version = "0.3.1"
+version = "0.4.0"
 edition = "2021"
 description = "Language Server implention for the SourcePawn programming language."
 license = "GPL-3.0"

src/parser/function_parser.rs

@@ -152,22 +152,16 @@ fn build_detail(
     visibility_node: Option<Node>,
     definition_type_node: Option<Node>,
 ) -> Result<String, Utf8Error> {
-    let mut detail = format!("{} {}", type_?.to_string(), name?.to_string());
-    if params_node.is_some() {
-        detail.push_str(
-            params_node
-                .unwrap()
-                .utf8_text(document.text.as_bytes())
-                .unwrap(),
-        );
+    let mut detail = format!("{} {}", type_?, name?);
+    if let Some(params_node) = params_node {
+        detail.push_str(params_node.utf8_text(document.text.as_bytes()).unwrap());
     }
     if visibility_node.is_some() {
         detail = format!(
             "{} {}",
             visibility_node
                 .unwrap()
-                .utf8_text(document.text.as_bytes())?
-                .to_string(),
+                .utf8_text(document.text.as_bytes())?,
             detail
         )
     }
@@ -271,10 +265,10 @@ fn read_function_parameters(
 }
 
 fn extract_param_doc(name: &str, documentation: &Description) -> Option<String> {
-    let re = Regex::new(&format!("@param\\s+(?:\\b{}\\b)([^@]+)", name.to_string())).unwrap();
+    let re = Regex::new(&format!("@param\\s+(?:\\b{}\\b)([^@]+)", name)).unwrap();
     if let Some(caps) = re.captures(&documentation.text) {
         if let Some(text) = caps.get(1) {
-            return Some(text.as_str().replace("*", "").trim().to_string());
+            return Some(text.as_str().replace('*', "").trim().to_string());
         }
     };
 

src/providers.rs

@@ -1,6 +1,7 @@
 pub mod completion;
 pub mod definition;
 pub mod hover;
+pub mod reference;
 pub mod semantic_tokens;
 pub mod signature_help;
 

src/providers/reference.rs

@@ -0,0 +1,33 @@
+use lsp_types::{Location, ReferenceParams};
+
+use crate::spitem::get_items_from_position;
+
+use super::FeatureRequest;
+
+/// Build a vector of [Locations](lsp_types::Location) from a [ReferenceParams](lsp_types::ReferenceParams).
+///
+/// # Arguments
+///
+/// * `request` - Reference request object [FeatureRequest<ReferenceParams>].
+pub fn provide_reference(request: FeatureRequest<ReferenceParams>) -> Option<Vec<Location>> {
+    let items = get_items_from_position(
+        &request.store,
+        request.params.text_document_position.position,
+        request
+            .params
+            .text_document_position
+            .text_document
+            .uri
+            .clone(),
+    );
+    let mut locations = vec![];
+    for item in items {
+        let item = item.lock().unwrap();
+        let references = item.references();
+        if let Some(references) = references {
+            locations.extend(references.clone());
+        }
+    }
+
+    Some(locations.iter().map(|loc| loc.to_lsp_location()).collect())
+}

src/server.rs

@@ -11,13 +11,13 @@ use lsp_types::{
         DidChangeConfiguration, DidChangeTextDocument, DidOpenTextDocument, ShowMessage,
     },
     request::{
-        Completion, GotoDefinition, HoverRequest, SemanticTokensFullRequest, SignatureHelpRequest,
-        WorkspaceConfiguration,
+        Completion, GotoDefinition, HoverRequest, References, SemanticTokensFullRequest,
+        SignatureHelpRequest, WorkspaceConfiguration,
     },
     CompletionOptions, CompletionParams, ConfigurationItem, ConfigurationParams,
     DidChangeConfigurationParams, DidChangeTextDocumentParams, DidOpenTextDocumentParams,
     GotoDefinitionParams, HoverParams, HoverProviderCapability, InitializeParams, MessageType,
-    OneOf, SemanticTokenModifier, SemanticTokenType, SemanticTokensFullOptions,
+    OneOf, ReferenceParams, SemanticTokenModifier, SemanticTokenType, SemanticTokensFullOptions,
     SemanticTokensLegend, SemanticTokensOptions, SemanticTokensParams,
     SemanticTokensServerCapabilities, ServerCapabilities, ShowMessageParams, SignatureHelpOptions,
     SignatureHelpParams, TextDocumentSyncCapability, TextDocumentSyncKind, Url,
@@ -163,6 +163,7 @@ impl Server {
                 retrigger_characters: Some(vec![",".to_string(), "(".to_string()]),
                 ..Default::default()
             }),
+            references_provider: Some(OneOf::Left(true)),
             semantic_tokens_provider: Some(
                 SemanticTokensServerCapabilities::SemanticTokensOptions(SemanticTokensOptions {
                     work_done_progress_options: WorkDoneProgressOptions {
@@ -443,6 +444,15 @@ impl Server {
         Ok(())
     }
 
+    fn reference(&mut self, id: RequestId, mut params: ReferenceParams) -> anyhow::Result<()> {
+        utils::normalize_uri(&mut params.text_document_position.text_document.uri);
+        let uri = Arc::new(params.text_document_position.text_document.uri.clone());
+        self.read_unscanned_document(uri.clone());
+
+        self.handle_feature_request(id, params, uri, providers::reference::provide_reference)?;
+        Ok(())
+    }
+
     fn handle_feature_request<P, R, H>(
         &self,
         id: RequestId,
@@ -491,6 +501,7 @@ impl Server {
                                 .on::<GotoDefinition, _>(|id, params| self.definition(id, params))?
                                 .on::<SemanticTokensFullRequest, _>(|id, params| self.semantic_tokens(id, params))?
                                 .on::<SignatureHelpRequest, _>(|id, params| self.signature_help(id, params))?
+                                .on::<References, _>(|id, params| self.reference(id, params))?
 
                                 .default()
                                 {

src/spitem.rs

@@ -32,6 +32,15 @@ pub struct Location {
     pub range: Range,
 }
 
+impl Location {
+    pub fn to_lsp_location(&self) -> lsp_types::Location {
+        lsp_types::Location {
+            uri: self.uri.as_ref().clone(),
+            range: self.range,
+        }
+    }
+}
+
 #[derive(Debug, Clone)]
 /// Generic representation of an item, which can be converted to a
 /// [CompletionItem](lsp_types::CompletionItem), [Location](lsp_types::Location), etc.