tree-sitter/cli/src/util.rs

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

#[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>\n<style>svg { width: 100%; }</style>\n\n";

pub fn cancel_on_stdin() -> Arc<AtomicUsize> {
    let result = Arc::new(AtomicUsize::new(0));
    if atty::is(atty::Stream::Stdin) {
        thread::spawn({
            let flag = result.clone();
            move || {
                let mut line = String::new();
                io::stdin().read_line(&mut line).unwrap();
                flag.store(1, Ordering::Relaxed);
            }
        });
    }
    result
}
#[cfg(windows)]
pub struct LogSession();

#[cfg(unix)]
pub struct LogSession(PathBuf, Option<Child>, Option<ChildStdin>);

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

#[cfg(unix)]
pub fn log_graphs(parser: &mut Parser, path: &str) -> Result<LogSession> {
    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."))?;
    parser.print_dot_graphs(&dot_stdin);
    Ok(LogSession(
        PathBuf::from(path),
        Some(dot_process),
        Some(dot_stdin),
    ))
}

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

        drop(self.2.take().unwrap());
        let output = self.1.take().unwrap().wait_with_output().unwrap();
        if output.status.success() {
            if cfg!(target_os = "macos")
                && fs::metadata(&self.0).unwrap().len() > HTML_HEADER.len() as u64
            {
                Command::new("open").arg(&self.0).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::io;`
			`use std::sync::atomic::{AtomicUsize, Ordering};`
			`use std::sync::Arc;`
			`use std::thread;`
			`use tree_sitter::Parser;`

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)]`
Get logging flags working properly with test script 2019-01-14 17:19:46 -08:00			`const HTML_HEADER: &[u8] = b"<!DOCTYPE html>\n<style>svg { width: 100%; }</style>\n\n";`

tags: Handle cancellation 2020-03-25 11:26:52 -07:00			`pub fn cancel_on_stdin() -> Arc<AtomicUsize> {`
			`let result = Arc::new(AtomicUsize::new(0));`
Tweak cancellation logic for CLI commands In 'parse' and 'highlight' cancel on stdin if stdin is a tty. 2020-10-22 15:55:51 -07:00			`if atty::is(atty::Stream::Stdin) {`
			`thread::spawn({`
			`let flag = result.clone();`
			`move \|\| {`
			`let mut line = String::new();`
			`io::stdin().read_line(&mut line).unwrap();`
			`flag.store(1, Ordering::Relaxed);`
			`}`
			`});`
			`}`
tags: Handle cancellation 2020-03-25 11:26:52 -07:00			`result`
			`}`
Avoid using unix-specific methods on windows 2019-01-10 15:50:54 -08:00			`#[cfg(windows)]`
Add benchmark script * Structure `cli` crate as both a library and an executable, so that benchmarks can import code from the crate. * Import macros in the Rust 2018 style. 2019-02-01 14:39:37 -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 benchmark script * Structure `cli` crate as both a library and an executable, so that benchmarks can import code from the crate. * Import macros in the Rust 2018 style. 2019-02-01 14:39:37 -08:00			`pub struct LogSession(PathBuf, Option<Child>, Option<ChildStdin>);`
Avoid using unix-specific methods on windows 2019-01-10 15:50:54 -08:00
			`#[cfg(windows)]`
Improve error message when failing to run graphviz stuff Fixes #682 2020-07-10 10:12:46 -07:00			`pub fn log_graphs(_parser: &mut Parser, _path: &str) -> Result<LogSession> {`
Get logging flags working properly with test script 2019-01-14 17:19:46 -08:00			`Ok(LogSession())`
Avoid using unix-specific methods on windows 2019-01-10 15:50:54 -08:00			`}`

			`#[cfg(unix)]`
Improve error message when failing to run graphviz stuff Fixes #682 2020-07-10 10:12:46 -07:00			`pub fn log_graphs(parser: &mut Parser, path: &str) -> Result<LogSession> {`
Get logging flags working properly with test script 2019-01-14 17:19:46 -08:00			`use std::io::Write;`
Add debug and debug-graph flags to parse and test commands 2019-01-08 21:03:51 -08:00
Get logging flags working properly with test script 2019-01-14 17:19:46 -08:00			`let mut dot_file = std::fs::File::create(path)?;`
			`dot_file.write(HTML_HEADER)?;`
Add debug and debug-graph flags to parse and test commands 2019-01-08 21:03:51 -08:00			`let mut dot_process = Command::new("dot")`
			`.arg("-Tsvg")`
			`.stdin(Stdio::piped())`
			`.stdout(dot_file)`
			`.spawn()`
cli: Use anyhow and thiserror for errors This patch updates the CLI to use anyhow and thiserror for error management. The main feature that our custom `Error` type was providing was a _list_ of messages, which would allow us to annotate "lower-level" errors with more contextual information. This is exactly what's provided by anyhow's `Context` trait. (This is setup work for a future PR that will pull the `config` and `loader` modules out into separate crates; by using `anyhow` we wouldn't have to deal with a circular dependency between with the new crates.) 2021-06-09 12:32:22 -04:00			.with_context(\|\| "Failed to run the `dot` command. Check that graphviz is installed.")?;
Add debug and debug-graph flags to parse and test commands 2019-01-08 21:03:51 -08:00			`let dot_stdin = dot_process`
			`.stdin`
			`.take()`
cli: Use anyhow and thiserror for errors This patch updates the CLI to use anyhow and thiserror for error management. The main feature that our custom `Error` type was providing was a _list_ of messages, which would allow us to annotate "lower-level" errors with more contextual information. This is exactly what's provided by anyhow's `Context` trait. (This is setup work for a future PR that will pull the `config` and `loader` modules out into separate crates; by using `anyhow` we wouldn't have to deal with a circular dependency between with the new crates.) 2021-06-09 12:32:22 -04:00			.ok_or_else(\|\| anyhow!("Failed to open stdin for `dot` process."))?;
Add debug and debug-graph flags to parse and test commands 2019-01-08 21:03:51 -08:00			`parser.print_dot_graphs(&dot_stdin);`
rustfmt 2019-01-17 17:16:04 -08:00			`Ok(LogSession(`
			`PathBuf::from(path),`
			`Some(dot_process),`
			`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;`

			`drop(self.2.take().unwrap());`
			`let output = self.1.take().unwrap().wait_with_output().unwrap();`
			`if output.status.success() {`
rustfmt 2019-01-17 17:16:04 -08:00			`if cfg!(target_os = "macos")`
			`&& fs::metadata(&self.0).unwrap().len() > HTML_HEADER.len() as u64`
			`{`
Include error recovery examples in test suite 2019-01-20 16:58:49 -08:00			`Command::new("open").arg(&self.0).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			`}`