1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280
#![doc = include_str!("../README.md")]
#![deny(clippy::unwrap_used, clippy::expect_used)]
#![warn(clippy::pedantic, clippy::nursery, clippy::cargo)]
#![deny(missing_debug_implementations, clippy::missing_panics_doc)]
#![warn(clippy::pedantic, clippy::nursery, clippy::cargo)]
#![deny(clippy::use_self, rust_2018_idioms)]
use core::fmt;
use supported_languages::SupportedLanguage;
use tree_sitter::{Language, LanguageError, Node, QueryError, Range, Tree};
/// For adding new language support, and some predefined support for certain languages,
pub mod supported_languages;
fn run_query<'a>(
query_str: &'a str,
lang: Language,
node: Node<'a>,
code: &'a [u8],
) -> Result<Box<[Range]>, QueryError> {
let query = tree_sitter::Query::new(lang, query_str)?;
let mut query_cursor = tree_sitter::QueryCursor::new();
let matches = query_cursor.matches(&query, node, code);
let ranges = matches.map(|m| m.captures[0].node.range());
Ok(ranges.collect())
}
/// Errors that we may give back.
#[derive(Debug)]
pub enum Error {
/// If there is no language that has this file extension or the file does not have a file
/// extension.
FileTypeUnkown(String),
/// If tree sitter fails to parse the file.
ParseError(String),
/// If tree sitter doesn't like the grammer for given language
GrammarLoad(&'static str, LanguageError),
/// If tree sitter doesn't like the query from a given [SupportedLanguage].
InvalidQuery(&'static str, QueryError),
/// If there are no result after filtering.
NoSuchResultsForFilter,
/// If there are no result after searching.
NoResultsForSearch,
}
/// Tries to find the appropiate language for the given file extension [`ext`] based on the list of
/// languages [`langs`] provided.
///
/// # Errors
/// If there is no language for this file extension in the provided language list.
pub fn get_file_type_from_file_ext<'a>(
ext: &str,
langs: &'a [&'a dyn SupportedLanguage],
) -> Result<&'a dyn SupportedLanguage, Error> {
langs
.iter()
.find(|lang| lang.file_exts().contains(&ext))
.copied()
.ok_or_else(|| Error::FileTypeUnkown(ext.to_string()))
}
/// Tries to find the appropiate language for the given file [`file_name`] based on the list of
/// languages [`langs`] provided.
/// This works by obtaining the extension from the file path and using
/// [`get_file_type_from_file_ext`].
///
/// # Errors
/// If there is no file extension for this file name, or there is no language for this file in the provided language list.
pub fn get_file_type_from_file<'a>(
file_name: &str,
langs: &'a [&'a dyn SupportedLanguage],
) -> Result<&'a dyn SupportedLanguage, Error> {
file_name
.rsplit_once('.')
.ok_or_else(|| Error::FileTypeUnkown(file_name.to_string()))
.map(|(_, ext)| ext)
.and_then(|ext| get_file_type_from_file_ext(ext, langs))
}
#[derive(Debug, Clone)]
/// The result of finding function with a given name.
/// Use [`Self::search_file`] or [`Self::search_file_with_name`] to do the searching.
pub struct ParsedFile<'a> {
// I believe we cannot store something refernceing the tree, so we cannot directly store the
// results of the query, but just their ranges so in the [`filter`] method we use the tree to
// obtain the correct nodes from their ranges
file: &'a str,
file_name: Option<&'a str>,
function_name: &'a str,
// TODO: maybe each supported language could define filters
// if so we would store dyn SupportedLanguage here
language_type: &'a str,
tree: Tree,
results: Box<[Range]>,
}
impl<'a> ParsedFile<'a> {
#[must_use]
pub fn new(
file: &'a str,
function_name: &'a str,
language_type: &'a str,
tree: Tree,
results: Box<[Range]>,
) -> Self {
Self {
file,
function_name,
language_type,
tree,
results,
file_name: None,
}
}
// TODO: maybe only make this hidden and expose a filter method that takes in some sort of
// filter trait
//
/// Filters out commits not matching the filter [`f`].
/// Returns new version of the current [`ParsedFile`] with only the results that match the
/// filter.
///
/// # Errors
/// If the filter [`f`] filters out all the results of this file
pub fn filter(&self, f: fn(&Node<'_>) -> bool) -> Result<Self, Error> {
let root = self.tree.root_node();
let ranges: Box<[Range]> = self
.ranges()
.filter_map(|range| root.descendant_for_point_range(range.start_point, range.end_point))
.filter(f)
.map(|n| n.range())
.collect();
if ranges.is_empty() {
return Err(Error::NoSuchResultsForFilter);
}
let clone = Self {
results: ranges,
..self.clone()
};
Ok(clone)
}
#[must_use]
/// Get the name of the language used to parse this file
pub const fn language(&self) -> &str {
self.language_type
}
#[must_use]
/// Get the name of the function that was searched for to make this [`ParsedFile`]
pub const fn search_name(&self) -> &str {
self.function_name
}
fn ranges(&self) -> impl Iterator<Item = &Range> {
self.results.iter()
}
/// Search for all function with the name [`name`], in string [`code`] with the specified
/// language [`language`].
///
/// Note: to obtain the the language you may use [`get_file_type_from_file`] or
/// [`get_file_type_from_file_ext`].
/// Alternativly use [`Self::search_file_with_name`] to let us find the correct language for you.
///
/// # Errors
/// If something with tree sitter goes wrong.
/// If the code cannot be parsed properly.
/// If no results are found for this function name.
pub fn search_file(
name: &'a str,
code: &'a str,
language: &'a dyn SupportedLanguage,
) -> Result<Self, Error> {
let code_bytes = code.as_bytes();
let mut parser = tree_sitter::Parser::new();
let ts_lang = language.language();
parser
.set_language(ts_lang)
.map_err(|lang_err| Error::GrammarLoad(language.name(), lang_err))?;
let parsed = parser
.parse(code, None)
.ok_or_else(|| Error::ParseError(code.to_string()))?;
let query_str = language.query(name);
let node = parsed.root_node();
let command_ranges = run_query(&query_str, ts_lang, node, code_bytes)
.map_err(|query_err| Error::InvalidQuery(language.name(), query_err))?;
if command_ranges.is_empty() {
return Err(Error::NoResultsForSearch);
}
Ok(ParsedFile::new(
code,
name,
language.name(),
parsed,
command_ranges,
))
}
/// Search for all function with the name [`name`], in string [`code`] with a language found
/// from the file name [`file_name`] and the languages [`langs`].
///
/// # Errors
/// If there is no language found for the given file name.
/// If something with tree sitter goes wrong.
/// If the code cannot be parsed properly,
/// If no results are found for this function name.
pub fn search_file_with_name(
name: &'a str,
code: &'a str,
file_name: &'a str,
langs: &'a [&'a dyn SupportedLanguage],
) -> Result<Self, Error> {
get_file_type_from_file(file_name, langs)
.and_then(|language| Self::search_file(name, code, language))
.map(|file| file.set_file_name(file_name))
}
fn set_file_name(mut self, file_name: &'a str) -> Self {
self.file_name.replace(file_name);
self
}
#[must_use]
/// Get the file name of this file.
pub const fn file_name(&self) -> Option<&str> {
self.file_name
}
#[must_use]
/// Get the [Range] of each found function.
pub fn results(&self) -> &[Range] {
&self.results
}
}
impl IntoIterator for ParsedFile<'_> {
type Item = (Range, String);
type IntoIter = Box<dyn Iterator<Item = Self::Item>>;
fn into_iter(self) -> Self::IntoIter {
Box::new(
self.ranges()
.map(|range| {
(
*range,
self.file[range.start_byte..range.end_byte].to_string(),
)
})
.collect::<Vec<_>>()
.into_iter(),
)
}
}
impl fmt::Display for ParsedFile<'_> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
let lines = self.file.lines().enumerate();
let texts = self
.ranges()
.map(move |range| {
lines
.clone()
.filter_map(move |(line, str)| {
if line >= range.start_point.row && line <= range.end_point.row {
Some(format!("{}: {str}", line + 1))
} else {
None
}
})
.collect::<Vec<_>>()
.join("\n")
})
.collect::<Vec<_>>()
.join("\n...\n");
write!(f, "{texts}")
}
}