use crate::TextRange; use ra_syntax::{ algo::visit::{visitor, Visitor}, ast::{self, AttrsOwner, NameOwner, TypeParamsOwner, TypeAscriptionOwner}, AstNode, SourceFile, SyntaxKind, SyntaxNode, WalkEvent, }; #[derive(Debug, Clone)] pub struct StructureNode { pub parent: Option, pub label: String, pub navigation_range: TextRange, pub node_range: TextRange, pub kind: SyntaxKind, pub detail: Option, pub deprecated: bool, } pub fn file_structure(file: &SourceFile) -> Vec { let mut res = Vec::new(); let mut stack = Vec::new(); for event in file.syntax().preorder() { match event { WalkEvent::Enter(node) => { if let Some(mut symbol) = structure_node(node) { symbol.parent = stack.last().map(|&n| n); stack.push(res.len()); res.push(symbol); } } WalkEvent::Leave(node) => { if structure_node(node).is_some() { stack.pop().unwrap(); } } } } res } fn structure_node(node: &SyntaxNode) -> Option { fn decl(node: &N) -> Option { decl_with_detail(node, None) } fn decl_with_ascription( node: &N, ) -> Option { decl_with_type_ref(node, node.ascribed_type()) } fn decl_with_type_ref( node: &N, type_ref: Option<&ast::TypeRef>, ) -> Option { let detail = type_ref.map(|type_ref| { let mut detail = String::new(); collapse_ws(type_ref.syntax(), &mut detail); detail }); decl_with_detail(node, detail) } fn decl_with_detail( node: &N, detail: Option, ) -> Option { let name = node.name()?; Some(StructureNode { parent: None, label: name.text().to_string(), navigation_range: name.syntax().range(), node_range: node.syntax().range(), kind: node.syntax().kind(), detail, deprecated: node.attrs().filter_map(|x| x.as_named()).any(|x| x == "deprecated"), }) } fn collapse_ws(node: &SyntaxNode, output: &mut String) { let mut can_insert_ws = false; for line in node.text().chunks().flat_map(|chunk| chunk.lines()) { let line = line.trim(); if line.is_empty() { if can_insert_ws { output.push_str(" "); can_insert_ws = false; } } else { output.push_str(line); can_insert_ws = true; } } } visitor() .visit(|fn_def: &ast::FnDef| { let mut detail = String::from("fn"); if let Some(type_param_list) = fn_def.type_param_list() { collapse_ws(type_param_list.syntax(), &mut detail); } if let Some(param_list) = fn_def.param_list() { collapse_ws(param_list.syntax(), &mut detail); } if let Some(ret_type) = fn_def.ret_type() { detail.push_str(" "); collapse_ws(ret_type.syntax(), &mut detail); } decl_with_detail(fn_def, Some(detail)) }) .visit(decl::) .visit(decl::) .visit(decl::) .visit(decl::) .visit(decl::) .visit(|td: &ast::TypeAliasDef| decl_with_type_ref(td, td.type_ref())) .visit(decl_with_ascription::) .visit(decl_with_ascription::) .visit(decl_with_ascription::) .visit(|im: &ast::ImplBlock| { let target_type = im.target_type()?; let target_trait = im.target_trait(); let label = match target_trait { None => format!("impl {}", target_type.syntax().text()), Some(t) => { format!("impl {} for {}", t.syntax().text(), target_type.syntax().text(),) } }; let node = StructureNode { parent: None, label, navigation_range: target_type.syntax().range(), node_range: im.syntax().range(), kind: im.syntax().kind(), detail: None, deprecated: false, }; Some(node) }) .accept(node)? } #[cfg(test)] mod tests { use super::*; use insta::assert_debug_snapshot_matches; #[test] fn test_file_structure() { let file = SourceFile::parse( r#" struct Foo { x: i32 } mod m { fn bar1() {} fn bar2(t: T) -> T {} fn bar3(a: A, b: B) -> Vec< u32 > {} } enum E { X, Y(i32) } type T = (); static S: i32 = 92; const C: i32 = 92; impl E {} impl fmt::Debug for E {} #[deprecated] fn obsolete() {} #[deprecated(note = "for awhile")] fn very_obsolete() {} "#, ) .ok() .unwrap(); let structure = file_structure(&file); assert_debug_snapshot_matches!("file_structure", structure); } }