sequoia-sq 1.4.0

//! Line wrapping human-readable output.

use std::fmt;
use std::io::Write;
use std::sync::OnceLock;

use libc;

/// A non-breaking space.
pub const NBSP: char = '\u{00A0}';

/// Prints the given message to the specified stream.
///
/// Hint: Use `weprintln!(..)` instead of invoking this function
/// directly.
///
/// Terminates the process with an error code if writing to the stream
/// fails.
pub fn wwriteln(stream: &mut dyn Write, msg: fmt::Arguments) {
    let m = format!("{}", msg);
    for l in textwrap::wrap(&m, options()) {
        if let Err(e) = writeln!(stream, "{}", l) {
            let mut exit_code = 1;
            // Handle `BrokenPipe` explicitly.
            #[cfg(unix)]
            if e.kind() == std::io::ErrorKind::BrokenPipe {
                // The 7th bit indicates an error.
                exit_code = 128 + libc::SIGPIPE;
            } else {
                eprintln!("Error: {}", e);
            }
            std::process::exit(exit_code);
        }
    }
}

/// Prints the given message to the specified stream, indenting
/// continuations.
///
/// Hint: Use `weprintln!(indent="...", ..)` or
/// `weprintln!(initial_indent="...", subsequent_indent="...", ..)`
/// instead of invoking this function directly.
///
/// Terminates the process with an error code if writing to the stream
/// fails.
pub fn iwwriteln(stream: &mut dyn Write,
                 initial_indent: &str,
                 subsequent_indent: &str,
                 msg: fmt::Arguments) {
    let m = format!("{}", msg);
    for l in textwrap::wrap(&m,
                            options()
                            .initial_indent(initial_indent)
                            .subsequent_indent(subsequent_indent)) {
        if let Err(e) = writeln!(stream, "{}", l) {
            let mut exit_code = 1;
            // Handle `BrokenPipe` explicitly.
            #[cfg(unix)]
            if e.kind() == std::io::ErrorKind::BrokenPipe {
                // The 7th bit indicates an error.
                exit_code = 128 + libc::SIGPIPE;
            } else {
                eprintln!("Error: {}", e);
            }
            std::process::exit(exit_code);
        }
    }
}

/// Returns options for text-wrapping.
fn options() -> textwrap::Options<'static> {
    static OPTIONS: OnceLock<textwrap::Options> = OnceLock::new();
    OPTIONS.get_or_init(|| {
        // It is better to use terminal_size instead of letting
        // textwrap do it, because textwrap uses an older version,
        // leading to duplicate crates.
        textwrap::Options::new(stderr_terminal_width())
        // Using a more naive separation algorithm keeps URLs
        // together, whereas the unicode line breaking algorithm would
        // break after e.g. `hkps://`.
            .word_separator(textwrap::WordSeparator::AsciiSpace)
    }).clone()
}

/// Returns the terminal width we assume for wrapping.
pub fn stderr_terminal_width() -> usize {
    // XXX: For compatibility with terminal_size 0.2 and 0.3.  Once we
    // depend on 0.4, use terminal_size_of instead.
    platform! {
        unix => {
            use std::os::fd::AsRawFd;
            #[allow(deprecated)]
            unsafe {
                terminal_size::terminal_size_using_fd(std::io::stderr().as_raw_fd())
            }
        },
        windows => {
            terminal_size::terminal_size()
        },
    }
        .map(|(w, _h)| w.0)
        .map(Into::into)
        .unwrap_or(usize::MAX)
}