rtsort 0.2.0

A real-time `sort` with a live terminal preview.
Documentation 
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

use clap::Parser;
use crossterm::{
    cursor::MoveTo,
    execute,
    terminal::{Clear, ClearType, EnterAlternateScreen, LeaveAlternateScreen},
};
use rtsort::{compare_human_numeric, compare_normal, compare_numeric};
use std::cmp::Ordering;
use std::io::{self, BufRead, Write, stderr};

#[derive(Parser, Debug)]
#[command(
    author,
    version,
    about = "A real-time sorting CLI utility",
    disable_help_flag = true
)]
struct Args {
    /// Compare according to string numerical value
    #[arg(short = 'n', long = "numeric-sort")]
    numeric_sort: bool,

    /// Compare according to human-readable numeric values (e.g., 2K, 1G)
    #[arg(short = 'h', long = "human-numeric-sort")]
    human_numeric_sort: bool,

    /// Reverse the result of comparisons
    #[arg(short = 'r', long = "reverse")]
    reverse: bool,

    /// Output only the first N lines of the sorted result
    #[arg(short = 't', long = "top")]
    top: Option<usize>,

    /// Print help
    #[arg(long, action = clap::ArgAction::Help)]
    help: Option<bool>,
}

struct AlternateScreenGuard;

impl AlternateScreenGuard {
    fn new() -> io::Result<Self> {
        execute!(stderr(), EnterAlternateScreen)?;
        Ok(Self)
    }
}

impl Drop for AlternateScreenGuard {
    fn drop(&mut self) {
        let _ = execute!(stderr(), LeaveAlternateScreen);
    }
}

fn run_sort_loop(
    cmp_fn: fn(&str, &str) -> Ordering,
    reverse: bool,
    top: Option<usize>,
) -> io::Result<Vec<String>> {
    let mut sorted_lines: Vec<String> = Vec::new();

    let stdin = io::stdin();
    let mut handle = stdin.lock();

    // To allow for responsive terminal manipulation even if stdout is piped
    let mut stderr = stderr();
    let mut guard: Option<AlternateScreenGuard> = None;

    let mut line_buffer = String::new();

    while handle.read_line(&mut line_buffer)? > 0 {
        let original_line = line_buffer.trim_end_matches(['\n', '\r']).to_string();

        if guard.is_none() {
            guard = Some(AlternateScreenGuard::new()?);
        }

        let pos = match sorted_lines.binary_search_by(|e| {
            let ord = cmp_fn(e, &original_line);
            if reverse { ord.reverse() } else { ord }
        }) {
            Ok(pos) | Err(pos) => pos,
        };

        if top.is_none_or(|n| sorted_lines.len() < n || pos < n) {
            sorted_lines.insert(pos, original_line);
            if let Some(n) = top {
                sorted_lines.truncate(n);
            }

            // Redraw from top: upstream stderr output is wiped on the next redraw
            execute!(stderr, Clear(ClearType::All), MoveTo(0, 0))?;
            for line in &sorted_lines {
                writeln!(stderr, "{line}")?;
            }
            stderr.flush()?;
        }

        line_buffer.clear();
    }

    Ok(sorted_lines)
}

fn main() -> io::Result<()> {
    let args = Args::parse();

    let cmp_fn: fn(&str, &str) -> Ordering = if args.human_numeric_sort {
        compare_human_numeric
    } else if args.numeric_sort {
        compare_numeric
    } else {
        compare_normal
    };

    let sorted_lines = run_sort_loop(cmp_fn, args.reverse, args.top)?;

    let mut stdout = io::stdout().lock();
    for line in &sorted_lines {
        writeln!(stdout, "{line}")?;
    }
    stdout.flush()?;

    Ok(())
}