mod binding_files; mod build_tables; mod char_tree; mod dedup; mod grammars; mod nfa; mod node_types; pub mod parse_grammar; mod prepare_grammar; mod render; mod rules; mod tables; use self::build_tables::build_tables; use self::grammars::{InlinedProductionMap, LexicalGrammar, SyntaxGrammar}; use self::parse_grammar::parse_grammar; use self::prepare_grammar::prepare_grammar; use self::render::render_c_code; use self::rules::AliasMap; use anyhow::{anyhow, Context, Result}; use lazy_static::lazy_static; use regex::{Regex, RegexBuilder}; use semver::Version; use std::io::Write; use std::path::Path; use std::process::{Command, Stdio}; use std::{env, fs}; lazy_static! { static ref JSON_COMMENT_REGEX: Regex = RegexBuilder::new("^\\s*//.*") .multi_line(true) .build() .unwrap(); } struct GeneratedParser { c_code: String, node_types_json: String, } pub fn generate_parser_in_directory( repo_path: &Path, grammar_path: Option<&str>, abi_version: usize, generate_bindings: bool, report_symbol_name: Option<&str>, js_runtime: Option<&str>, ) -> Result<()> { let src_path = repo_path.join("src"); let header_path = src_path.join("tree_sitter"); // Read the grammar.json. let grammar_json = if let Some(path) = grammar_path { load_grammar_file(path.as_ref(), js_runtime)? } else { let grammar_js_path = grammar_path.map_or(repo_path.join("grammar.js"), std::convert::Into::into); load_grammar_file(&grammar_js_path, js_runtime)? }; // Ensure that the output directories exist. fs::create_dir_all(&src_path)?; fs::create_dir_all(&header_path)?; if grammar_path.is_none() { fs::write(src_path.join("grammar.json"), &grammar_json) .with_context(|| format!("Failed to write grammar.json to {src_path:?}"))?; } // Parse and preprocess the grammar. let input_grammar = parse_grammar(&grammar_json)?; let (syntax_grammar, lexical_grammar, inlines, simple_aliases) = prepare_grammar(&input_grammar)?; let language_name = input_grammar.name; // Generate the parser and related files. let GeneratedParser { c_code, node_types_json, } = generate_parser_for_grammar_with_opts( &language_name, syntax_grammar, lexical_grammar, &inlines, simple_aliases, abi_version, report_symbol_name, )?; write_file(&src_path.join("parser.c"), c_code)?; write_file(&src_path.join("node-types.json"), node_types_json)?; write_file(&header_path.join("parser.h"), tree_sitter::PARSER_HEADER)?; if generate_bindings { binding_files::generate_binding_files(repo_path, &language_name)?; } Ok(()) } pub fn generate_parser_for_grammar(grammar_json: &str) -> Result<(String, String)> { let grammar_json = JSON_COMMENT_REGEX.replace_all(grammar_json, "\n"); let input_grammar = parse_grammar(&grammar_json)?; let (syntax_grammar, lexical_grammar, inlines, simple_aliases) = prepare_grammar(&input_grammar)?; let parser = generate_parser_for_grammar_with_opts( &input_grammar.name, syntax_grammar, lexical_grammar, &inlines, simple_aliases, tree_sitter::LANGUAGE_VERSION, None, )?; Ok((input_grammar.name, parser.c_code)) } fn generate_parser_for_grammar_with_opts( name: &str, syntax_grammar: SyntaxGrammar, lexical_grammar: LexicalGrammar, inlines: &InlinedProductionMap, simple_aliases: AliasMap, abi_version: usize, report_symbol_name: Option<&str>, ) -> Result { let variable_info = node_types::get_variable_info(&syntax_grammar, &lexical_grammar, &simple_aliases)?; let node_types_json = node_types::generate_node_types_json( &syntax_grammar, &lexical_grammar, &simple_aliases, &variable_info, ); let (parse_table, main_lex_table, keyword_lex_table, keyword_capture_token) = build_tables( &syntax_grammar, &lexical_grammar, &simple_aliases, &variable_info, inlines, report_symbol_name, )?; let c_code = render_c_code( name, parse_table, main_lex_table, keyword_lex_table, keyword_capture_token, syntax_grammar, lexical_grammar, simple_aliases, abi_version, ); Ok(GeneratedParser { c_code, node_types_json: serde_json::to_string_pretty(&node_types_json).unwrap(), }) } pub fn load_grammar_file(grammar_path: &Path, js_runtime: Option<&str>) -> Result { if grammar_path.is_dir() { return Err(anyhow!( "Path to a grammar file with `.js` or `.json` extension is required" )); } match grammar_path.extension().and_then(|e| e.to_str()) { Some("js") => Ok(load_js_grammar_file(grammar_path, js_runtime) .with_context(|| "Failed to load grammar.js")?), Some("json") => { Ok(fs::read_to_string(grammar_path).with_context(|| "Failed to load grammar.json")?) } _ => Err(anyhow!("Unknown grammar file extension: {grammar_path:?}",)), } } fn load_js_grammar_file(grammar_path: &Path, js_runtime: Option<&str>) -> Result { let grammar_path = fs::canonicalize(grammar_path)?; let js_runtime = js_runtime.unwrap_or("node"); let mut node_process = Command::new(js_runtime) .env("TREE_SITTER_GRAMMAR_PATH", grammar_path) .stdin(Stdio::piped()) .stdout(Stdio::piped()) .spawn() .with_context(|| format!("Failed to run `{js_runtime}`"))?; let mut node_stdin = node_process .stdin .take() .with_context(|| "Failed to open stdin for node")?; let cli_version = Version::parse(env!("CARGO_PKG_VERSION")) .with_context(|| "Could not parse this package's version as semver.")?; write!( node_stdin, "global.TREE_SITTER_CLI_VERSION_MAJOR = {}; global.TREE_SITTER_CLI_VERSION_MINOR = {}; global.TREE_SITTER_CLI_VERSION_PATCH = {};", cli_version.major, cli_version.minor, cli_version.patch, ) .with_context(|| "Failed to write tree-sitter version to node's stdin")?; let javascript_code = include_bytes!("./dsl.js"); node_stdin .write(javascript_code) .with_context(|| "Failed to write grammar dsl to node's stdin")?; drop(node_stdin); let output = node_process .wait_with_output() .with_context(|| "Failed to read output from node")?; match output.status.code() { None => panic!("Node process was killed"), Some(0) => { let stdout = String::from_utf8(output.stdout).with_context(|| "Got invalid UTF8 from node")?; let mut grammar_json = &stdout[..]; if let Some(pos) = stdout.rfind('\n') { // If there's a newline, split the last line from the rest of the output let node_output = &stdout[..pos]; grammar_json = &stdout[pos + 1..]; let mut stdout = std::io::stdout().lock(); stdout.write_all(node_output.as_bytes())?; stdout.write_all(b"\n")?; stdout.flush()?; } Ok(serde_json::to_string_pretty( &serde_json::from_str::(grammar_json) .with_context(|| "Failed to parse grammar JSON")?, ) .with_context(|| "Failed to serialize grammar JSON")? + "\n") } Some(code) => Err(anyhow!("Node process exited with status {code}")), } } fn write_file(path: &Path, body: impl AsRef<[u8]>) -> Result<()> { fs::write(path, body) .with_context(|| format!("Failed to write {:?}", path.file_name().unwrap())) }