tree-sitter/cli/src/util.rs

use anyhow::Result;
use std::sync::atomic::{AtomicUsize, Ordering};
use std::sync::Arc;
use tree_sitter::{Parser, Tree};

#[cfg(unix)]
use anyhow::{anyhow, Context};
#[cfg(unix)]
use std::path::PathBuf;
#[cfg(unix)]
use std::process::{Child, ChildStdin, Command, Stdio};

#[cfg(unix)]
const HTML_HEADER: &[u8] = b"
<!DOCTYPE html>

<style>
svg { width: 100%; }
</style>

";

pub fn cancel_on_signal() -> Arc<AtomicUsize> {
    let result = Arc::new(AtomicUsize::new(0));
    ctrlc::set_handler({
        let flag = result.clone();
        move || {
            flag.store(1, Ordering::Relaxed);
        }
    })
    .expect("Error setting Ctrl-C handler");
    result
}

#[cfg(windows)]
pub struct LogSession;

#[cfg(unix)]
pub struct LogSession {
    path: PathBuf,
    dot_process: Option<Child>,
    dot_process_stdin: Option<ChildStdin>,
}

#[cfg(windows)]
pub fn print_tree_graph(_tree: &Tree, _path: &str) -> Result<()> {
    Ok(())
}

#[cfg(windows)]
pub fn log_graphs(_parser: &mut Parser, _path: &str) -> Result<LogSession> {
    Ok(LogSession)
}

#[cfg(unix)]
pub fn print_tree_graph(tree: &Tree, path: &str) -> Result<()> {
    let session = LogSession::new(path)?;
    tree.print_dot_graph(session.dot_process_stdin.as_ref().unwrap());
    Ok(())
}

#[cfg(unix)]
pub fn log_graphs(parser: &mut Parser, path: &str) -> Result<LogSession> {
    let session = LogSession::new(path)?;
    parser.print_dot_graphs(session.dot_process_stdin.as_ref().unwrap());
    Ok(session)
}

#[cfg(unix)]
impl LogSession {
    fn new(path: &str) -> Result<Self> {
        use std::io::Write;

        let mut dot_file = std::fs::File::create(path)?;
        dot_file.write(HTML_HEADER)?;
        let mut dot_process = Command::new("dot")
            .arg("-Tsvg")
            .stdin(Stdio::piped())
            .stdout(dot_file)
            .spawn()
            .with_context(|| {
                "Failed to run the `dot` command. Check that graphviz is installed."
            })?;
        let dot_stdin = dot_process
            .stdin
            .take()
            .ok_or_else(|| anyhow!("Failed to open stdin for `dot` process."))?;
        Ok(Self {
            path: PathBuf::from(path),
            dot_process: Some(dot_process),
            dot_process_stdin: Some(dot_stdin),
        })
    }
}

#[cfg(unix)]
impl Drop for LogSession {
    fn drop(&mut self) {
        use std::fs;

        drop(self.dot_process_stdin.take().unwrap());
        let output = self.dot_process.take().unwrap().wait_with_output().unwrap();
        if output.status.success() {
            if cfg!(target_os = "macos")
                && fs::metadata(&self.path).unwrap().len() > HTML_HEADER.len() as u64
            {
                Command::new("open").arg(&self.path).output().unwrap();
            }
        } else {
            eprintln!(
                "Dot failed: {} {}",
                String::from_utf8_lossy(&output.stdout),
                String::from_utf8_lossy(&output.stderr)
            );
        }
    }
}
Fixed cargo fmt 2021-09-28 18:53:24 -04:00			`use anyhow::Result;`
tags: Handle cancellation 2020-03-25 11:26:52 -07:00			`use std::sync::atomic::{AtomicUsize, Ordering};`
			`use std::sync::Arc;`
Add --dot flag to parse subcommand, for printing tree as DOT graph 2023-02-13 12:33:34 -08:00			`use tree_sitter::{Parser, Tree};`
tags: Handle cancellation 2020-03-25 11:26:52 -07:00
Fix linux build 2021-09-28 19:06:05 -04:00			`#[cfg(unix)]`
			`use anyhow::{anyhow, Context};`
Get logging flags working properly with test script 2019-01-14 17:19:46 -08:00			`#[cfg(unix)]`
			`use std::path::PathBuf;`
			`#[cfg(unix)]`
Add debug and debug-graph flags to parse and test commands 2019-01-08 21:03:51 -08:00			`use std::process::{Child, ChildStdin, Command, Stdio};`

Upload binary artifacts from CI builds 2019-01-15 19:18:33 -08:00			`#[cfg(unix)]`
Fix CLI build on windows 2023-02-13 23:23:47 -08:00			`const HTML_HEADER: &[u8] = b"`
			`<!DOCTYPE html>`

			`<style>`
			`svg { width: 100%; }`
			`</style>`

			`";`
Get logging flags working properly with test script 2019-01-14 17:19:46 -08:00
fix: use SIGINT instead of stdin for interruption to don't mess up piped commands 2023-05-02 10:34:55 +03:00			`pub fn cancel_on_signal() -> Arc<AtomicUsize> {`
tags: Handle cancellation 2020-03-25 11:26:52 -07:00			`let result = Arc::new(AtomicUsize::new(0));`
fix: use SIGINT instead of stdin for interruption to don't mess up piped commands 2023-05-02 10:34:55 +03:00			`ctrlc::set_handler({`
			`let flag = result.clone();`
			`move \|\| {`
			`flag.store(1, Ordering::Relaxed);`
			`}`
			`})`
			`.expect("Error setting Ctrl-C handler");`
tags: Handle cancellation 2020-03-25 11:26:52 -07:00			`result`
			`}`
Add --dot flag to parse subcommand, for printing tree as DOT graph 2023-02-13 12:33:34 -08:00
Avoid using unix-specific methods on windows 2019-01-10 15:50:54 -08:00			`#[cfg(windows)]`
Add --dot flag to parse subcommand, for printing tree as DOT graph 2023-02-13 12:33:34 -08:00			`pub struct LogSession;`
Avoid using unix-specific methods on windows 2019-01-10 15:50:54 -08:00
Get logging flags working properly with test script 2019-01-14 17:19:46 -08:00			`#[cfg(unix)]`
Add --dot flag to parse subcommand, for printing tree as DOT graph 2023-02-13 12:33:34 -08:00			`pub struct LogSession {`
			`path: PathBuf,`
			`dot_process: Option<Child>,`
			`dot_process_stdin: Option<ChildStdin>,`
			`}`

Fix CLI build on windows 2023-02-13 23:23:47 -08:00			`#[cfg(windows)]`
			`pub fn print_tree_graph(_tree: &Tree, _path: &str) -> Result<()> {`
			`Ok(())`
			`}`

			`#[cfg(windows)]`
			`pub fn log_graphs(_parser: &mut Parser, _path: &str) -> Result<LogSession> {`
			`Ok(LogSession)`
			`}`

			`#[cfg(unix)]`
Add --dot flag to parse subcommand, for printing tree as DOT graph 2023-02-13 12:33:34 -08:00			`pub fn print_tree_graph(tree: &Tree, path: &str) -> Result<()> {`
			`let session = LogSession::new(path)?;`
			`tree.print_dot_graph(session.dot_process_stdin.as_ref().unwrap());`
			`Ok(())`
			`}`

Fix CLI build on windows 2023-02-13 23:23:47 -08:00			`#[cfg(unix)]`
Add --dot flag to parse subcommand, for printing tree as DOT graph 2023-02-13 12:33:34 -08:00			`pub fn log_graphs(parser: &mut Parser, path: &str) -> Result<LogSession> {`
			`let session = LogSession::new(path)?;`
			`parser.print_dot_graphs(session.dot_process_stdin.as_ref().unwrap());`
			`Ok(session)`
			`}`
Avoid using unix-specific methods on windows 2019-01-10 15:50:54 -08:00
			`#[cfg(unix)]`
Add --dot flag to parse subcommand, for printing tree as DOT graph 2023-02-13 12:33:34 -08:00			`impl LogSession {`
			`fn new(path: &str) -> Result<Self> {`
			`use std::io::Write;`
Add debug and debug-graph flags to parse and test commands 2019-01-08 21:03:51 -08:00
Add --dot flag to parse subcommand, for printing tree as DOT graph 2023-02-13 12:33:34 -08:00			`let mut dot_file = std::fs::File::create(path)?;`
			`dot_file.write(HTML_HEADER)?;`
			`let mut dot_process = Command::new("dot")`
			`.arg("-Tsvg")`
			`.stdin(Stdio::piped())`
			`.stdout(dot_file)`
			`.spawn()`
			`.with_context(\|\| {`
			"Failed to run the `dot` command. Check that graphviz is installed."
			`})?;`
			`let dot_stdin = dot_process`
			`.stdin`
			`.take()`
			.ok_or_else(\|\| anyhow!("Failed to open stdin for `dot` process."))?;
			`Ok(Self {`
			`path: PathBuf::from(path),`
			`dot_process: Some(dot_process),`
			`dot_process_stdin: Some(dot_stdin),`
			`})`
			`}`
Add debug and debug-graph flags to parse and test commands 2019-01-08 21:03:51 -08:00			`}`

Avoid using unix-specific methods on windows 2019-01-10 15:50:54 -08:00			`#[cfg(unix)]`
Get logging flags working properly with test script 2019-01-14 17:19:46 -08:00			`impl Drop for LogSession {`
			`fn drop(&mut self) {`
			`use std::fs;`

Add --dot flag to parse subcommand, for printing tree as DOT graph 2023-02-13 12:33:34 -08:00			`drop(self.dot_process_stdin.take().unwrap());`
			`let output = self.dot_process.take().unwrap().wait_with_output().unwrap();`
Get logging flags working properly with test script 2019-01-14 17:19:46 -08:00			`if output.status.success() {`
rustfmt 2019-01-17 17:16:04 -08:00			`if cfg!(target_os = "macos")`
Add --dot flag to parse subcommand, for printing tree as DOT graph 2023-02-13 12:33:34 -08:00			`&& fs::metadata(&self.path).unwrap().len() > HTML_HEADER.len() as u64`
rustfmt 2019-01-17 17:16:04 -08:00			`{`
Add --dot flag to parse subcommand, for printing tree as DOT graph 2023-02-13 12:33:34 -08:00			`Command::new("open").arg(&self.path).output().unwrap();`
Get logging flags working properly with test script 2019-01-14 17:19:46 -08:00			`}`
			`} else {`
rustfmt 2019-01-17 17:16:04 -08:00			`eprintln!(`
			`"Dot failed: {} {}",`
			`String::from_utf8_lossy(&output.stdout),`
			`String::from_utf8_lossy(&output.stderr)`
			`);`
Get logging flags working properly with test script 2019-01-14 17:19:46 -08:00			`}`
Avoid using unix-specific methods on windows 2019-01-10 15:50:54 -08:00			`}`
Add debug and debug-graph flags to parse and test commands 2019-01-08 21:03:51 -08:00			`}`