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 Idris;
impl Language for Idris {
fn name(&self) -> &'static str {
"Idris"
}
fn extensions(&self) -> &'static [&'static str] {
&["idr", "lidr"]
}
fn grammar_name(&self) -> &'static str {
"idris"
}
fn has_symbols(&self) -> bool {
true
}
fn container_kinds(&self) -> &'static [&'static str] {
&["data", "record", "interface"]
}
fn function_kinds(&self) -> &'static [&'static str] {
&["function", "signature"]
}
fn type_kinds(&self) -> &'static [&'static str] {
&[] }
fn import_kinds(&self) -> &'static [&'static str] {
&["import"]
}
fn public_symbol_kinds(&self) -> &'static [&'static str] {
&["function", "data", "record"]
}
fn visibility_mechanism(&self) -> VisibilityMechanism {
VisibilityMechanism::ExplicitExport
}
fn extract_public_symbols(&self, node: &Node, content: &str) -> Vec<Export> {
match node.kind() {
"function" | "signature" => {
if let Some(name) = self.node_name(node, content) {
return vec![Export {
name: name.to_string(),
kind: SymbolKind::Function,
line: node.start_position().row + 1,
}];
}
}
"data" | "record" | "interface" => {
if let Some(name) = self.node_name(node, content) {
return vec![Export {
name: name.to_string(),
kind: SymbolKind::Type,
line: node.start_position().row + 1,
}];
}
}
_ => {}
}
Vec::new()
}
fn scope_creating_kinds(&self) -> &'static [&'static str] {
&["function", "where", "exp_let_in", "exp_do"]
}
fn control_flow_kinds(&self) -> &'static [&'static str] {
&["exp_if", "exp_case"]
}
fn complexity_nodes(&self) -> &'static [&'static str] {
&["exp_if", "exp_case", "alt"]
}
fn nesting_nodes(&self) -> &'static [&'static str] {
&["exp_if", "exp_case", "exp_do", "exp_let_in"]
}
fn signature_suffix(&self) -> &'static str {
""
}
fn extract_function(&self, node: &Node, content: &str, _in_container: bool) -> Option<Symbol> {
match node.kind() {
"function" | "signature" => {
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: SymbolKind::Function,
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(),
})
}
_ => None,
}
}
fn extract_container(&self, node: &Node, content: &str) -> Option<Symbol> {
match node.kind() {
"data" | "record" | "interface" => {
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: SymbolKind::Type,
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(),
})
}
_ => None,
}
}
fn extract_type(&self, _node: &Node, _content: &str) -> Option<Symbol> {
None }
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!("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 {
let name = symbol.name.as_str();
match symbol.kind {
crate::SymbolKind::Function | crate::SymbolKind::Method => name.starts_with("test_"),
crate::SymbolKind::Module => name == "tests" || name == "test",
_ => 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 !["idr", "lidr"].contains(&ext) {
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!("{}.idr", module), format!("{}.lidr", module)]
}
fn lang_key(&self) -> &'static str {
"idris"
}
fn is_stdlib_import(&self, import_name: &str, _project_root: &Path) -> bool {
import_name.starts_with("Prelude")
|| import_name.starts_with("Data.")
|| import_name.starts_with("Control.")
}
fn find_stdlib(&self, _project_root: &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] {
&["idr", "lidr"]
}
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(".idr")
.or_else(|| entry_name.strip_suffix(".lidr"))
.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] = &[
"exp_else", "exp_with", "exp_lambda", "exp_lambda_case",
"exp_list_comprehension", "lambda_exp", "lambda_args",
"type_signature", "type_parens", "type_braces", "type_var", "forall",
"parameters_body", "namespace_body", "mutual_body", "data_body",
"record_body", "interface_body", "implementation_body",
"interface_head", "interface_name", "module",
"operator", "qualified_operator", "qualified_dot_operators", "dot_operator",
"ticked_operator", "tuple_operator",
"qualified_loname", "qualified_caname",
"constructor", "statement", "declarations",
"with", "with_pat", "with_arg",
"pragma_export", "pragma_foreign", "pragma_foreign_impl", "pragma_transform",
];
validate_unused_kinds_audit(&Idris, documented_unused)
.expect("Idris unused node kinds audit failed");
}
}