use std::collections::HashMap; use lsp_types::{ PartialResultParams, Position, Range, ReferenceContext, ReferenceParams, TextDocumentPositionParams, WorkDoneProgressParams, }; use crate::language_server::tests::{TestProject, find_position_of}; fn find_references( tester: &TestProject<'_>, position: Position, ) -> Option>> { let locations = tester.at(position, |engine, params, _| { let params = ReferenceParams { text_document_position: TextDocumentPositionParams { text_document: params.text_document, position, }, work_done_progress_params: WorkDoneProgressParams::default(), partial_result_params: PartialResultParams::default(), context: ReferenceContext { include_declaration: true, }, }; engine.find_references(params).result.unwrap() })?; let mut references: HashMap> = HashMap::new(); for location in locations { let module_name = tester .module_name_from_url(&location.uri) .expect("Valid uri"); _ = references .entry(module_name) .or_default() .push(location.range); } Some(references) } fn show_references(code: &str, position: Option, ranges: &[Range]) -> String { let mut buffer = String::new(); for (line_number, line) in code.lines().enumerate() { let mut underline = String::new(); let mut underline_empty = true; let line_number = line_number as u32; if let Some(Range { start, end }) = ranges .iter() .find(|range| range.start.line == line_number && range.end.line == line_number) { for (column_number, _) in line.chars().enumerate() { let current_position = Position::new(line_number, column_number as u32); if Some(current_position) == position { underline_empty = false; underline.push('↑'); } else if start.le(¤t_position) && current_position.lt(&end) { underline_empty = false; underline.push('▔'); } else { underline.push(' '); } } } buffer.push_str(line); if !underline_empty { buffer.push('\n'); buffer.push_str(&underline); } buffer.push('\n'); } buffer } macro_rules! assert_references { ($code:literal, $position:expr $(,)?) => { assert_references!(TestProject::for_source($code), $position); }; (($module_name:literal, $module_src:literal), $code:literal, $position:expr $(,)?) => { assert_references!( TestProject::for_source($code).add_module($module_name, $module_src), $position ); }; ($project:expr, $position:expr $(,)?) => { let project = $project; let src = project.src; let position = $position.find_position(src); let result = find_references(&project, position).expect("References not found"); let mut output = String::new(); for (name, src) in project.root_package_modules.iter() { output.push_str(&format!( "-- {name}.gleam\n{}\n\n", show_references(src, None, result.get(*name).unwrap_or(&Vec::new())) )); } output.push_str(&format!( "-- app.gleam\n{}", show_references( src, Some(position), result.get("app").unwrap_or(&Vec::new()) ) )); insta::assert_snapshot!(insta::internals::AutoName, output, src); }; } macro_rules! assert_no_references { ($code:literal, $position:expr $(,)?) => { let project = TestProject::for_source($code); assert_no_references!(&project, $position); }; ($project:expr, $position:expr $(,)?) => { let src = $project.src; let position = $position.find_position(src); let result = find_references($project, position); assert_eq!(result, None); }; } #[test] fn references_for_local_variable() { assert_references!( " pub fn main() { let wibble = 10 let wobble = wibble + 1 wibble + wobble } ", find_position_of("wibble").nth_occurrence(2), ); } #[test] fn references_for_local_variable_from_definition() { assert_references!( " pub fn main() { let wibble = 10 let wobble = wibble + 1 wibble + wobble } ", find_position_of("wibble"), ); } #[test] fn references_for_private_function() { assert_references!( " fn wibble() { wibble() } pub fn main() { let _ = wibble() wibble() + 4 } fn wobble() { wibble() || wobble() } ", find_position_of("wibble"), ); } #[test] fn references_for_private_function_from_reference() { assert_references!( " fn wibble() { wibble() } pub fn main() { let _ = wibble() wibble() + 4 } fn wobble() { wibble() || wobble() } ", find_position_of("wibble").nth_occurrence(2), ); } #[test] fn references_for_public_function() { assert_references!( ( "mod", " import app.{wibble} fn wobble() { app.wibble() } fn other() { wibble() } " ), " pub fn wibble() { wibble() } ", find_position_of("wibble").nth_occurrence(2), ); } #[test] fn references_for_function_from_qualified_reference() { assert_references!( ( "mod", " pub fn wibble() { wibble() } " ), " import mod pub fn main() { let value = mod.wibble() mod.wibble() value } ", find_position_of("wibble"), ); } #[test] fn references_for_function_from_unqualified_reference() { assert_references!( ( "mod", " pub fn wibble() { wibble() } " ), " import mod.{wibble} pub fn main() { let value = wibble() mod.wibble() value } ", find_position_of("wibble()"), ); } #[test] fn references_for_private_constant() { assert_references!( " const wibble = 10 pub fn main() { let _ = wibble wibble + 4 } fn wobble() { wibble + wobble() } ", find_position_of("wibble"), ); } #[test] fn references_for_private_constant_from_reference() { assert_references!( " const wibble = 10 pub fn main() { let _ = wibble wibble + 4 } fn wobble() { wibble + wobble() } ", find_position_of("wibble").nth_occurrence(2), ); } #[test] fn references_for_public_constant() { assert_references!( ( "mod", " import app.{wibble} fn wobble() { app.wibble } fn other() { wibble } " ), " pub const wibble = 10 pub fn main() { wibble } ", find_position_of("wibble").nth_occurrence(2), ); } #[test] fn references_for_constant_from_qualified_reference() { assert_references!( ( "mod", " pub const wibble = 10 fn wobble() { wibble } " ), " import mod pub fn main() { let value = mod.wibble mod.wibble + value } ", find_position_of("wibble"), ); } #[test] fn references_for_constant_from_unqualified_reference() { assert_references!( ( "mod", " pub const wibble = 10 fn wobble() { wibble } " ), " import mod.{wibble} pub fn main() { let value = mod.wibble wibble + value } ", find_position_of("wibble +"), ); } #[test] fn references_for_private_type_variant() { assert_references!( " type Wibble { Wibble } fn main() { let _ = Wibble Wibble } fn wobble() { Wibble wobble() } ", find_position_of("Wibble }"), ); } #[test] fn references_for_private_type_variant_from_reference() { assert_references!( " type Wibble { Wibble } fn main() { let _ = Wibble Wibble } fn wobble() { Wibble wobble() } ", find_position_of(" = Wibble").under_char('W'), ); } #[test] fn references_for_public_type_variant() { assert_references!( ( "mod", " import app.{Wibble} fn wobble() { app.Wibble } fn other() { Wibble } " ), " pub type Wibble { Wibble } pub fn main() { Wibble } ", find_position_of("Wibble }"), ); } #[test] fn references_for_type_variant_from_qualified_reference() { assert_references!( ( "mod", " pub type Wibble { Wibble } fn wobble() { Wibble } " ), " import mod pub fn main() { let value = mod.Wibble mod.Wibble value } ", find_position_of("Wibble"), ); } #[test] fn references_for_type_variant_from_unqualified_reference() { assert_references!( ( "mod", " pub type Wibble { Wibble } fn wobble() { Wibble } " ), " import mod.{Wibble} pub fn main() { let value = mod.Wibble Wibble } ", find_position_of("Wibble").nth_occurrence(3), ); } #[test] fn no_references_for_keyword() { assert_no_references!( " pub fn wibble() { todo } ", find_position_of("fn") ); } #[test] fn references_for_aliased_value() { assert_references!( ( "mod", " import app.{Wibble as Wobble} fn wobble() { Wobble } " ), " pub type Wibble { Wibble } pub fn main() { Wibble } ", find_position_of("Wibble").nth_occurrence(2), ); } #[test] fn references_for_aliased_const() { assert_references!( ( "mod", " import app.{wibble as other} fn wobble() { other } " ), " pub const wibble = 123 pub fn main() { wibble } ", find_position_of("wibble").nth_occurrence(2), ); } #[test] fn references_for_aliased_function() { assert_references!( ( "mod", " import app.{wibble as other} fn wobble() { other() } " ), " pub fn wibble() { 123 } pub fn main() { wibble() } ", find_position_of("wibble").nth_occurrence(2), ); } #[test] fn references_for_private_type() { assert_references!( " type Wibble { Wibble } fn main() -> Wibble { todo } fn wobble(w: Wibble) { todo } ", find_position_of("Wibble"), ); } #[test] fn references_for_private_type_from_reference() { assert_references!( " type Wibble { Wibble } fn main() -> Wibble { todo } fn wobble(w: Wibble) { todo } ", find_position_of("-> Wibble").under_char('W'), ); } #[test] fn references_for_public_type() { assert_references!( ( "mod", " import app.{type Wibble} fn wobble() -> Wibble { todo } fn other(w: app.Wibble) { todo } " ), " pub type Wibble { Wibble } pub fn main() -> Wibble { todo } ", find_position_of("Wibble"), ); } #[test] fn references_for_type_from_qualified_reference() { assert_references!( ( "mod", " pub type Wibble { Wibble } fn wobble() -> Wibble { todo } " ), " import mod pub fn main() -> mod.Wibble { let _: mod.Wibble = todo } ", find_position_of("Wibble"), ); } #[test] fn references_for_type_from_unqualified_reference() { assert_references!( ( "mod", " pub type Wibble { Wibble } fn wobble() -> Wibble { todo } " ), " import mod.{type Wibble} pub fn main() -> Wibble { let _: mod.Wibble = todo } ", find_position_of("Wibble").nth_occurrence(2), ); } #[test] fn references_for_aliased_type() { assert_references!( ( "mod", " import app.{type Wibble as Wobble} fn wobble() -> Wobble { todo } fn other(w: app.Wibble) { todo } " ), " pub type Wibble { Wibble } pub fn main() -> Wibble { todo } ", find_position_of("-> Wibble").under_char('W'), ); } #[test] fn references_for_type_from_let_annotation() { assert_references!( ( "mod", " pub type Wibble { Wibble } fn wobble() -> Wibble { todo } " ), " import mod.{type Wibble} pub fn main() -> Wibble { let _: mod.Wibble = todo } ", find_position_of("mod.Wibble").under_char('W'), ); }