feat: go-to Owl components and templates

Desdaemon · Desdaemon · commit d5cf8f60e5e9 · 2024-05-17T22:02:14.000-04:00
diff --git a/src/backend.rs b/src/backend.rs
@@ -29,6 +29,7 @@ use odoo_lsp::{format_loc, some, utils::*};
 
 pub struct Backend {
 	pub client: Client,
+	/// fs path -> rope, diagnostics etc.
 	pub document_map: DashMap<String, Document>,
 	pub record_ranges: DashMap<String, Box<[ByteRange]>>,
 	pub ast_map: DashMap<String, Tree>,
@@ -387,7 +388,7 @@ impl Backend {
 			.map(|model| {
 				let label = interner().resolve(model.key()).to_string();
 				let module = model.base.as_ref().and_then(|base| {
-					let module = self.index.module_of_path(&base.0.path.as_path())?;
+					let module = self.index.module_of_path(&base.0.path.to_path())?;
 					Some(interner().resolve(&module).to_string())
 				});
 				CompletionItem {
@@ -419,20 +420,18 @@ impl Backend {
 			offset_range_to_lsp_range(range, rope).ok_or_else(|| diagnostic!("(complete_template_name) range"))?;
 		let interner = interner();
 		let by_prefix = self.index.templates.by_prefix.read().await;
-		let matches = by_prefix.iter_prefix(needle.as_bytes()).flat_map(|(_, templates)| {
-			templates.iter().flat_map(|key| {
-				let label = interner.resolve(key).to_string();
-				Some(CompletionItem {
-					text_edit: Some(CompletionTextEdit::InsertAndReplace(InsertReplaceEdit {
-						new_text: label.clone(),
-						insert: range,
-						replace: range,
-					})),
-					label,
-					kind: Some(CompletionItemKind::REFERENCE),
-					..Default::default()
-				})
-			})
+		let matches = by_prefix.iter_prefix(needle.as_bytes()).map(|(_, key)| {
+			let label = interner.resolve(key).to_string();
+			CompletionItem {
+				text_edit: Some(CompletionTextEdit::InsertAndReplace(InsertReplaceEdit {
+					new_text: label.clone(),
+					insert: range,
+					replace: range,
+				})),
+				label,
+				kind: Some(CompletionItemKind::REFERENCE),
+				..Default::default()
+			}
 		});
 		items.extend(matches);
 		Ok(())
@@ -520,7 +519,7 @@ impl Backend {
 		let module = component
 			.location
 			.as_ref()
-			.and_then(|loc| self.index.module_of_path(&loc.path.as_path()));
+			.and_then(|loc| self.index.module_of_path(&loc.path.to_path()));
 		let value = fomat!(
 			"```js\n"
 			"(component) class " (name) ";\n"
@@ -540,7 +539,7 @@ impl Backend {
 		let module = template
 			.location
 			.as_ref()
-			.and_then(|loc| self.index.module_of_path(&loc.path.as_path()));
+			.and_then(|loc| self.index.module_of_path(&loc.path.to_path()));
 		let value = fomat!(
 			"```xml\n"
 			"<t t-name=\"" (name) "\"/>\n"
@@ -683,13 +682,13 @@ impl Backend {
 		let module = model
 			.base
 			.as_ref()
-			.and_then(|base| self.index.module_of_path(&base.0.path.as_path()));
+			.and_then(|base| self.index.module_of_path(&base.0.path.to_path()));
 		let mut descendants = model
 			.descendants
 			.iter()
 			.map(|loc| &loc.0)
 			.scan(SymbolSet::default(), |mods, loc| {
-				let Some(module) = self.index.module_of_path(&loc.path.as_path()) else {
+				let Some(module) = self.index.module_of_path(&loc.path.to_path()) else {
 					return Some(None);
 				};
 				if mods.insert(module) {
@@ -743,7 +742,7 @@ impl Backend {
 			}
 			if let Some(module) = self
 				.index
-				.module_of_path(&field.location.path.as_path())
+				.module_of_path(&field.location.path.to_path())
 			{
 				"*Defined in:* `" (interner().resolve(&module)) "`  \n"
 			}
diff --git a/src/index/symbol.rs b/src/index/symbol.rs
@@ -32,10 +32,14 @@ impl PathSymbol {
 		let empty = interner().get_or_intern_static(".");
 		PathSymbol(empty, empty)
 	}
-	pub fn as_path(&self) -> PathBuf {
+	pub fn to_path(&self) -> PathBuf {
 		let root = Path::new(interner().resolve(&self.0));
 		root.join(interner().resolve(&self.1))
 	}
+	pub fn as_string(&self) -> String {
+		let path = self.to_path();
+		path.to_string_lossy().into_owned()
+	}
 }
 
 impl Display for PathSymbol {
diff --git a/src/index/template.rs b/src/index/template.rs
@@ -1,5 +1,3 @@
-use std::collections::HashSet;
-
 use derive_more::Deref;
 
 use dashmap::DashMap;
@@ -19,7 +17,7 @@ pub struct TemplateIndex {
 	pub by_prefix: RwLock<TemplatePrefixTrie>,
 }
 
-pub type TemplatePrefixTrie = qp_trie::Trie<&'static [u8], HashSet<TemplateName>>;
+pub type TemplatePrefixTrie = qp_trie::Trie<&'static [u8], TemplateName>;
 
 impl TemplateIndex {
 	pub async fn append(&self, entries: Vec<NewTemplate>) {
@@ -38,10 +36,7 @@ impl TemplateIndex {
 				self.entry(entry.name).or_default().descendants.push(entry.template);
 			}
 			let raw = interner().resolve(&entry.name);
-			prefix
-				.entry(raw.as_bytes())
-				.or_insert_with(Default::default)
-				.insert(entry.name);
+			prefix.insert(raw.as_bytes(), entry.name);
 		}
 	}
 	pub(super) fn statistics(&self) -> serde_json::Value {
diff --git a/src/main.rs b/src/main.rs
@@ -170,6 +170,12 @@ impl LanguageServer for Backend {
 				references_provider: Some(OneOf::Left(true)),
 				workspace_symbol_provider: Some(OneOf::Left(true)),
 				diagnostic_provider: Some(DiagnosticServerCapabilities::Options(Default::default())),
+				// XML code actions are done in 1 pass only
+				code_action_provider: Some(CodeActionProviderCapability::Simple(true)),
+				execute_command_provider: Some(ExecuteCommandOptions {
+					commands: vec!["goto_owl".to_string()],
+					..Default::default()
+				}),
 				text_document_sync: Some(TextDocumentSyncCapability::Options(TextDocumentSyncOptions {
 					change: Some(TextDocumentSyncKind::INCREMENTAL),
 					save: Some(TextDocumentSyncSaveOptions::Supported(true)),
@@ -636,9 +642,6 @@ impl LanguageServer for Backend {
 		}
 		self.index.mark_n_sweep();
 	}
-	async fn execute_command(&self, _: ExecuteCommandParams) -> Result<Option<Value>> {
-		Ok(None)
-	}
 	async fn symbol(&self, params: WorkspaceSymbolParams) -> Result<Option<Vec<SymbolInformation>>> {
 		let query = &params.query;
 
@@ -709,7 +712,7 @@ impl LanguageServer for Backend {
 					damage_zone,
 					&mut document.diagnostics_cache,
 				);
-				diagnostics = document.diagnostics_cache.clone();
+				diagnostics.clone_from(&document.diagnostics_cache);
 			}
 		}
 		Ok(DocumentDiagnosticReportResult::Report(DocumentDiagnosticReport::Full(
@@ -722,6 +725,43 @@ impl LanguageServer for Backend {
 			},
 		)))
 	}
+	async fn code_action(&self, params: CodeActionParams) -> Result<Option<CodeActionResponse>> {
+		let Some((_, "xml")) = params.text_document.uri.path().rsplit_once('.') else {
+			return Ok(None);
+		};
+
+		let document = some!(self.document_map.get(params.text_document.uri.path()));
+
+		Ok(self
+			.xml_code_actions(params, document.rope.clone())
+			.inspect_err(|err| {
+				error!("(code_lens) {err}");
+			})
+			.unwrap_or(None))
+	}
+	async fn execute_command(&self, params: ExecuteCommandParams) -> Result<Option<Value>> {
+		match (params.command.as_str(), params.arguments.as_slice()) {
+			("goto_owl", [Value::String(_), Value::String(subcomponent)]) => {
+				// FIXME: Subcomponents should not just depend on the component's name,
+				// since users can readjust subcomponents' names at will.
+				let component = some!(interner().get(subcomponent));
+				let component = some!(self.index.components.get(&component.into()));
+				let location = some!(component.location.as_ref());
+				_ = self
+					.client
+					.show_document(ShowDocumentParams {
+						uri: Url::from_file_path(location.path.as_string()).unwrap(),
+						external: Some(false),
+						take_focus: Some(true),
+						selection: Some(location.range),
+					})
+					.await;
+			}
+			_ => {}
+		}
+
+		Ok(None)
+	}
 }
 
 #[tokio::main(flavor = "current_thread")]
diff --git a/src/model.rs b/src/model.rs
@@ -224,7 +224,7 @@ impl ModelIndex {
 					return None;
 				}
 				let mut fields = vec![];
-				let fpath = location.path.as_path();
+				let fpath = location.path.to_path();
 				let contents = std::fs::read(&fpath)
 					.map_err(|err| error!("Failed to read {}:\n{err}", fpath.display()))
 					.ok()?;
@@ -513,7 +513,7 @@ impl ModelEntry {
 			return Ok(());
 		};
 		if self.docstring.is_none() {
-			let contents = tokio::fs::read(loc.path.as_path()).await.into_diagnostic()?;
+			let contents = tokio::fs::read(loc.path.to_path()).await.into_diagnostic()?;
 			let mut parser = Parser::new();
 			parser.set_language(tree_sitter_python::language()).into_diagnostic()?;
 			let ast = parser
diff --git a/src/xml.rs b/src/xml.rs
@@ -10,6 +10,7 @@ use std::sync::Arc;
 use lasso::Spur;
 use log::{debug, warn};
 use miette::diagnostic;
+use odoo_lsp::component::ComponentTemplate;
 use odoo_lsp::index::{interner, PathSymbol};
 use odoo_lsp::model::{Field, FieldKind};
 use odoo_lsp::template::gather_templates;
@@ -37,6 +38,8 @@ enum RefKind<'a> {
 	/// An arbitrary Python expression.
 	/// Includes the relative offset of where the cursor is.
 	PyExpr(usize),
+	/// `<Component />`
+	Component,
 }
 
 enum Tag<'a> {
@@ -328,7 +331,7 @@ impl Backend {
 					&mut items,
 				)?;
 			}
-			RefKind::TName => return Ok(None),
+			RefKind::TName | RefKind::Component => return Ok(None),
 		}
 
 		Ok(Some(CompletionResponse::List(CompletionList {
@@ -384,6 +387,14 @@ impl Backend {
 				let model = some!(self.resolve_type(&model, &Scope::default()));
 				self.jump_def_field_name(&field, interner().resolve(&model))
 			}
+			Some(RefKind::Component) => {
+				let component = some!(interner().get(needle));
+				let component = some!(self.index.components.get(&component.into()));
+				let Some(ComponentTemplate::Name(template)) = component.template.as_ref() else {
+					return Ok(None);
+				};
+				self.jump_def_template_name(interner().resolve(template))
+			}
 			None => Ok(None),
 		}
 	}
@@ -413,7 +424,11 @@ impl Backend {
 			Some(RefKind::Ref(_)) | Some(RefKind::Id) => self.record_references(cursor_value, current_module),
 			Some(RefKind::TInherit) | Some(RefKind::TCall) => self.template_references(cursor_value, true),
 			Some(RefKind::TName) => self.template_references(cursor_value, false),
-			Some(RefKind::PyExpr(_)) | Some(RefKind::FieldName(_)) | Some(RefKind::PropOf(..)) | None => Ok(None),
+			Some(RefKind::PyExpr(_))
+			| Some(RefKind::FieldName(_))
+			| Some(RefKind::PropOf(..))
+			| Some(RefKind::Component)
+			| None => Ok(None),
 		}
 	}
 	pub fn xml_hover(&self, params: HoverParams, rope: Rope) -> miette::Result<Option<Hover>> {
@@ -513,7 +528,7 @@ impl Backend {
 					offset_range_to_lsp_range(range.map_unit(|rel_unit| ByteOffset(rel_unit + anchor)), rope.clone()),
 				)
 			}
-			Some(RefKind::TName) | Some(RefKind::PropOf(..)) | None => {
+			Some(RefKind::TName) | Some(RefKind::PropOf(..)) | Some(RefKind::Component) | None => {
 				#[cfg(not(debug_assertions))]
 				return Ok(None);
 
@@ -531,6 +546,28 @@ impl Backend {
 			}
 		}
 	}
+	pub fn xml_code_actions(&self, params: CodeActionParams, rope: Rope) -> miette::Result<Option<CodeActionResponse>> {
+		let uri = &params.text_document.uri;
+		let position = params.range.start;
+		let (slice, offset_at_cursor, _) = self.record_slice(&rope, uri, position)?;
+		let slice_str = Cow::from(slice);
+		let mut reader = Tokenizer::from(slice_str.as_ref());
+
+		let XmlRefs {
+			ref_at_cursor,
+			ref_kind,
+			..
+		} = self.gather_refs(offset_at_cursor, &mut reader, &slice)?;
+		let (Some((value, _)), Some(RefKind::Component)) = (ref_at_cursor, ref_kind) else {
+			return Ok(None);
+		};
+
+		Ok(Some(vec![CodeActionOrCommand::Command(Command {
+			title: "Go to Owl component".to_string(),
+			command: "goto_owl".to_string(),
+			arguments: Some(vec![String::new().into(), value.into()]),
+		})]))
+	}
 	/// The main function that determines all the information needed
 	/// to resolve the symbol at the cursor.
 	fn gather_refs<'read>(
@@ -569,7 +606,7 @@ impl Backend {
 
 		for token in reader {
 			match token {
-				Ok(Token::ElementStart { local, .. }) => {
+				Ok(Token::ElementStart { local, prefix, .. }) => {
 					expect_model_string = false;
 					depth += 1;
 					match local.as_str() {
@@ -585,6 +622,10 @@ impl Backend {
 						}
 						component if template_mode && component.starts_with(|c| char::is_ascii_uppercase(&c)) => {
 							tag = Some(Tag::TComponent(component));
+							if prefix.is_empty() && local.range().contains_end(offset_at_cursor) {
+								ref_at_cursor = Some((local.as_str(), local.range()));
+								ref_kind = Some(RefKind::Component);
+							}
 						}
 						_ if arch_mode => tag = None,
 						_ => {}

Original file line number	Diff line number	Diff line change
`@@ -32,10 +32,14 @@ impl PathSymbol {`
`32`	`32`	`let empty = interner().get_or_intern_static(".");`
`33`	`33`	`PathSymbol(empty, empty)`
`34`	`34`	`}`
`35`		`- pub fn as_path(&self) -> PathBuf {`
	`35`	`+ pub fn to_path(&self) -> PathBuf {`
`36`	`36`	`let root = Path::new(interner().resolve(&self.0));`
`37`	`37`	`root.join(interner().resolve(&self.1))`
`38`	`38`	`}`
	`39`	`+ pub fn as_string(&self) -> String {`
	`40`	`+ let path = self.to_path();`
	`41`	`+ path.to_string_lossy().into_owned()`
	`42`	`+ }`
`39`	`43`	`}`
`40`	`44`
`41`	`45`	`impl Display for PathSymbol {`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,3 @@`
`1`		`-use std::collections::HashSet;`
`2`		`-`
`3`	`1`	`use derive_more::Deref;`
`4`	`2`
`5`	`3`	`use dashmap::DashMap;`
`@@ -19,7 +17,7 @@ pub struct TemplateIndex {`
`19`	`17`	`pub by_prefix: RwLock<TemplatePrefixTrie>,`
`20`	`18`	`}`
`21`	`19`
`22`		`-pub type TemplatePrefixTrie = qp_trie::Trie<&'static [u8], HashSet<TemplateName>>;`
	`20`	`+pub type TemplatePrefixTrie = qp_trie::Trie<&'static [u8], TemplateName>;`
`23`	`21`
`24`	`22`	`impl TemplateIndex {`
`25`	`23`	`pub async fn append(&self, entries: Vec<NewTemplate>) {`
`@@ -38,10 +36,7 @@ impl TemplateIndex {`
`38`	`36`	`self.entry(entry.name).or_default().descendants.push(entry.template);`
`39`	`37`	`}`
`40`	`38`	`let raw = interner().resolve(&entry.name);`
`41`		`- prefix`
`42`		`- .entry(raw.as_bytes())`
`43`		`- .or_insert_with(Default::default)`
`44`		`- .insert(entry.name);`
	`39`	`+ prefix.insert(raw.as_bytes(), entry.name);`
`45`	`40`	`}`
`46`	`41`	`}`
`47`	`42`	`pub(super) fn statistics(&self) -> serde_json::Value {`