use crate::external_packages::ResolvedPackage;
use crate::{Export, Import, Language, Symbol, SymbolKind, Visibility, VisibilityMechanism};
use std::path::{Path, PathBuf};
use tree_sitter::Node;
pub struct Capnp;
impl Language for Capnp {
fn name(&self) -> &'static str {
"Cap'n Proto"
}
fn extensions(&self) -> &'static [&'static str] {
&["capnp"]
}
fn grammar_name(&self) -> &'static str {
"capnp"
}
fn has_symbols(&self) -> bool {
true
}
fn container_kinds(&self) -> &'static [&'static str] {
&["struct", "interface", "enum"]
}
fn function_kinds(&self) -> &'static [&'static str] {
&["method"]
}
fn type_kinds(&self) -> &'static [&'static str] {
&["struct", "interface", "enum"]
}
fn import_kinds(&self) -> &'static [&'static str] {
&["import"]
}
fn public_symbol_kinds(&self) -> &'static [&'static str] {
&["struct", "interface", "enum"]
}
fn visibility_mechanism(&self) -> VisibilityMechanism {
VisibilityMechanism::AllPublic
}
fn extract_public_symbols(&self, node: &Node, content: &str) -> Vec<Export> {
let kind = match node.kind() {
"struct" => SymbolKind::Struct,
"interface" => SymbolKind::Interface,
"enum" => SymbolKind::Enum,
_ => return Vec::new(),
};
if let Some(name) = self.node_name(node, content) {
return vec![Export {
name: name.to_string(),
kind,
line: node.start_position().row + 1,
}];
}
Vec::new()
}
fn scope_creating_kinds(&self) -> &'static [&'static str] {
&["struct", "interface"]
}
fn control_flow_kinds(&self) -> &'static [&'static str] {
&[]
}
fn complexity_nodes(&self) -> &'static [&'static str] {
&[]
}
fn nesting_nodes(&self) -> &'static [&'static str] {
&["struct", "interface"]
}
fn signature_suffix(&self) -> &'static str {
""
}
fn extract_function(&self, node: &Node, content: &str, _in_container: bool) -> Option<Symbol> {
if node.kind() != "method" {
return None;
}
let name = self.node_name(node, content)?;
let text = &content[node.byte_range()];
Some(Symbol {
name: name.to_string(),
kind: SymbolKind::Function,
signature: text.trim().to_string(),
docstring: None,
attributes: Vec::new(),
start_line: node.start_position().row + 1,
end_line: node.end_position().row + 1,
visibility: Visibility::Public,
children: Vec::new(),
is_interface_impl: false,
implements: Vec::new(),
})
}
fn extract_container(&self, node: &Node, content: &str) -> Option<Symbol> {
let kind = match node.kind() {
"struct" => SymbolKind::Struct,
"interface" => SymbolKind::Interface,
"enum" => SymbolKind::Enum,
_ => return None,
};
let name = self.node_name(node, content)?;
let text = &content[node.byte_range()];
let first_line = text.lines().next().unwrap_or(text);
Some(Symbol {
name: name.to_string(),
kind,
signature: first_line.trim().to_string(),
docstring: None,
attributes: Vec::new(),
start_line: node.start_position().row + 1,
end_line: node.end_position().row + 1,
visibility: Visibility::Public,
children: Vec::new(),
is_interface_impl: false,
implements: Vec::new(),
})
}
fn extract_type(&self, node: &Node, content: &str) -> Option<Symbol> {
self.extract_container(node, content)
}
fn extract_docstring(&self, _node: &Node, _content: &str) -> Option<String> {
None
}
fn extract_attributes(&self, _node: &Node, _content: &str) -> Vec<String> {
Vec::new()
}
fn extract_imports(&self, node: &Node, content: &str) -> Vec<Import> {
if node.kind() != "import" {
return Vec::new();
}
let text = &content[node.byte_range()];
vec![Import {
module: text.trim().to_string(),
names: Vec::new(),
alias: None,
is_wildcard: false,
is_relative: false,
line: node.start_position().row + 1,
}]
}
fn format_import(&self, import: &Import, _names: Option<&[&str]>) -> String {
format!("using import \"{}\"", import.module)
}
fn is_public(&self, _node: &Node, _content: &str) -> bool {
true
}
fn get_visibility(&self, _node: &Node, _content: &str) -> Visibility {
Visibility::Public
}
fn is_test_symbol(&self, _symbol: &crate::Symbol) -> bool {
false
}
fn embedded_content(&self, _node: &Node, _content: &str) -> Option<crate::EmbeddedBlock> {
None
}
fn container_body<'a>(&self, node: &'a Node<'a>) -> Option<Node<'a>> {
node.child_by_field_name("body")
}
fn body_has_docstring(&self, _body: &Node, _content: &str) -> bool {
false
}
fn node_name<'a>(&self, node: &Node, content: &'a str) -> Option<&'a str> {
node.child_by_field_name("name")
.map(|n| &content[n.byte_range()])
}
fn file_path_to_module_name(&self, path: &Path) -> Option<String> {
let ext = path.extension()?.to_str()?;
if ext != "capnp" {
return None;
}
let stem = path.file_stem()?.to_str()?;
Some(stem.to_string())
}
fn module_name_to_paths(&self, module: &str) -> Vec<String> {
vec![format!("{}.capnp", module)]
}
fn lang_key(&self) -> &'static str {
"capnp"
}
fn is_stdlib_import(&self, _: &str, _: &Path) -> bool {
false
}
fn find_stdlib(&self, _: &Path) -> Option<PathBuf> {
None
}
fn resolve_local_import(&self, _: &str, _: &Path, _: &Path) -> Option<PathBuf> {
None
}
fn resolve_external_import(&self, _: &str, _: &Path) -> Option<ResolvedPackage> {
None
}
fn get_version(&self, _: &Path) -> Option<String> {
None
}
fn find_package_cache(&self, _: &Path) -> Option<PathBuf> {
None
}
fn indexable_extensions(&self) -> &'static [&'static str] {
&["capnp"]
}
fn package_sources(&self, _: &Path) -> Vec<crate::PackageSource> {
Vec::new()
}
fn should_skip_package_entry(&self, name: &str, is_dir: bool) -> bool {
use crate::traits::{has_extension, skip_dotfiles};
if skip_dotfiles(name) {
return true;
}
!is_dir && !has_extension(name, self.indexable_extensions())
}
fn discover_packages(&self, _: &crate::PackageSource) -> Vec<(String, PathBuf)> {
Vec::new()
}
fn package_module_name(&self, entry_name: &str) -> String {
entry_name
.strip_suffix(".capnp")
.unwrap_or(entry_name)
.to_string()
}
fn find_package_entry(&self, path: &Path) -> Option<PathBuf> {
if path.is_file() {
Some(path.to_path_buf())
} else {
None
}
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::validate_unused_kinds_audit;
#[test]
fn unused_node_kinds_audit() {
#[rustfmt::skip]
let documented_unused: &[&str] = &[
"type_identifier", "type_definition", "primitive_type", "list_type",
"custom_type", "field_type", "extend_type",
"method_identifier", "method_parameters", "return_type", "return_identifier",
"named_return_type", "named_return_types", "unnamed_return_type", "param_identifier",
"nested_struct", "nested_enum", "enum_field", "enum_member", "enum_identifier",
"field_identifier", "struct_shorthand",
"import_path", "import_using",
"const_identifier", "generic_identifier", "annotation_identifier",
"annotation_definition_identifier", "unique_id_statement",
"top_level_annotation_body", "block_text",
];
validate_unused_kinds_audit(&Capnp, documented_unused)
.expect("Cap'n Proto unused node kinds audit failed");
}
}