git-delta 0.21.1

A syntax-highlighting pager for git
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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
use std::borrow::Cow;
use std::collections::{HashMap, VecDeque};
use std::io::{self, BufRead, IsTerminal, Write};

use bytelines::ByteLines;

use crate::ansi;
use crate::cli;
use crate::config::delta_unreachable;
use crate::config::Config;
use crate::config::GrepType;
use crate::features;
use crate::handlers::grep;
use crate::handlers::hunk_header::{AmbiguousDiffMinusCounter, ParsedHunkHeader};
use crate::handlers::{self, merge_conflict};
use crate::paint::Painter;
use crate::style::DecorationStyle;
use crate::utils;

#[derive(Clone, Debug, PartialEq, Eq)]
pub enum State {
    CommitMeta,                                             // In commit metadata section
    DiffHeader(DiffType), // In diff metadata section, between (possible) commit metadata and first hunk
    HunkHeader(DiffType, ParsedHunkHeader, String, String), // In hunk metadata line (diff_type, parsed, line, raw_line)
    HunkZero(DiffType, Option<String>), // In hunk; unchanged line (prefix, raw_line)
    HunkMinus(DiffType, Option<String>), // In hunk; removed line (diff_type, raw_line)
    HunkPlus(DiffType, Option<String>), // In hunk; added line (diff_type, raw_line)
    MergeConflict(MergeParents, merge_conflict::MergeConflictCommit),
    SubmoduleLog, // In a submodule section, with gitconfig diff.submodule = log
    SubmoduleShort(String), // In a submodule section, with gitconfig diff.submodule = short
    Blame(String), // In a line of `git blame` output (key).
    GitShowFile,  // In a line of `git show $revision:./path/to/file.ext` output
    Grep(GrepType, grep::LineType, String, Option<usize>), // In a line of `git grep` output (grep_type, line_type, path, line_number)
    Unknown,
    // The following elements are created when a line is wrapped to display it:
    HunkZeroWrapped,  // Wrapped unchanged line
    HunkMinusWrapped, // Wrapped removed line
    HunkPlusWrapped,  // Wrapped added line
}

#[derive(Clone, Debug, PartialEq, Eq)]
pub enum DiffType {
    Unified,
    // https://git-scm.com/docs/git-diff#_combined_diff_format
    Combined(MergeParents, InMergeConflict),
}

#[derive(Clone, Debug, PartialEq, Eq)]
pub enum MergeParents {
    Number(usize),  // Number of parent commits == (number of @s in hunk header) - 1
    Prefix(String), // Hunk line prefix, length == number of parent commits
    Unknown,
}

#[derive(Clone, Debug, PartialEq, Eq)]
pub enum InMergeConflict {
    Yes,
    No,
}

impl DiffType {
    pub fn n_parents(&self) -> usize {
        use DiffType::*;
        use MergeParents::*;
        match self {
            Combined(Prefix(prefix), _) => prefix.len(),
            Combined(Number(n_parents), _) => *n_parents,
            Unified => 1,
            Combined(Unknown, _) => delta_unreachable("Number of merge parents must be known."),
        }
    }
}

#[derive(Debug, PartialEq, Eq)]
pub enum Source {
    GitDiff,     // Coming from a `git diff` command
    DiffUnified, // Coming from a `diff -u` command
    Unknown,
}

// Possible transitions, with actions on entry:
//
//
// | from \ to   | CommitMeta  | DiffHeader  | HunkHeader  | HunkZero    | HunkMinus   | HunkPlus |
// |-------------+-------------+-------------+-------------+-------------+-------------+----------|
// | CommitMeta  | emit        | emit        |             |             |             |          |
// | DiffHeader  |             | emit        | emit        |             |             |          |
// | HunkHeader  |             |             |             | emit        | push        | push     |
// | HunkZero    | emit        | emit        | emit        | emit        | push        | push     |
// | HunkMinus   | flush, emit | flush, emit | flush, emit | flush, emit | push        | push     |
// | HunkPlus    | flush, emit | flush, emit | flush, emit | flush, emit | flush, push | push     |

pub struct StateMachine<'a> {
    pub line: String,
    pub raw_line: String,
    pub state: State,
    pub source: Source,
    pub minus_file: String,
    pub plus_file: String,
    pub minus_file_event: handlers::diff_header::FileEvent,
    pub plus_file_event: handlers::diff_header::FileEvent,
    pub diff_line: String,
    pub mode_info: String,
    pub painter: Painter<'a>,
    pub config: &'a Config,

    // When a file is modified, we use lines starting with '---' or '+++' to obtain the file name.
    // When a file is renamed without changes, we use lines starting with 'rename' to obtain the
    // file name (there is no diff hunk and hence no lines starting with '---' or '+++'). But when
    // a file is renamed with changes, both are present, and we rely on the following variables to
    // avoid emitting the file meta header line twice (#245).
    pub current_file_pair: Option<(String, String)>,
    pub handled_diff_header_header_line_file_pair: Option<(String, String)>,
    pub blame_key_colors: HashMap<String, String>,
    pub minus_line_counter: AmbiguousDiffMinusCounter,
    /// With `--color-only`, file header rows written before the file's path is
    /// known (`write_color_only_header_row`).
    pub held_header_rows: Vec<u8>,
    // With --side-by-side=hunk, the layout of the hunk whose header has been read but not yet
    // emitted. See look_ahead_at_hunk.
    pub hunk_side_by_side: Option<bool>,
}

pub fn delta<I>(lines: ByteLines<I>, writer: &mut dyn Write, config: &Config) -> std::io::Result<()>
where
    I: BufRead,
{
    // Announce protocol support as the first output, so a host can probe delta even on
    // an empty diff (which produces no per-line records). See features::diff_line_metadata.
    let handshake = features::diff_line_metadata::handshake();
    if !handshake.is_empty() {
        writer.write_all(handshake.as_bytes())?;
    }
    StateMachine::new(writer, config).consume(lines)
}

impl<'a> StateMachine<'a> {
    pub fn new(writer: &'a mut dyn Write, config: &'a Config) -> Self {
        Self {
            line: "".to_string(),
            raw_line: "".to_string(),
            state: State::Unknown,
            source: Source::Unknown,
            minus_file: "".to_string(),
            plus_file: "".to_string(),
            minus_file_event: handlers::diff_header::FileEvent::NoEvent,
            plus_file_event: handlers::diff_header::FileEvent::NoEvent,
            diff_line: "".to_string(),
            mode_info: "".to_string(),
            current_file_pair: None,
            handled_diff_header_header_line_file_pair: None,
            painter: Painter::new(writer, config),
            config,
            blame_key_colors: HashMap::new(),
            minus_line_counter: AmbiguousDiffMinusCounter::not_needed(),
            held_header_rows: Vec::new(),
            hunk_side_by_side: None,
        }
    }

    pub(crate) fn consume<I>(&mut self, mut lines: ByteLines<I>) -> std::io::Result<()>
    where
        I: BufRead,
    {
        // Lines read ahead of the line being handled, see look_ahead_at_hunk.
        let mut lookahead: VecDeque<Vec<u8>> = VecDeque::new();
        loop {
            if let Some(raw_line_bytes) = lookahead.pop_front() {
                self.handle_line(&raw_line_bytes)?;
            } else if let Some(Ok(raw_line_bytes)) = lines.next() {
                self.handle_line(raw_line_bytes)?;
            } else {
                break;
            }
            if self.config.side_by_side
                && self.config.side_by_side_scope == cli::SideBySideScope::Hunk
            {
                if let State::HunkHeader(..) = self.state {
                    self.look_ahead_at_hunk(&mut lines, &mut lookahead);
                }
            }
        }

        self.release_held_header_rows()?;
        self.handle_pending_line_with_diff_name()?;
        self.painter.paint_buffered_minus_and_plus_lines();
        self.painter.emit()?;
        Ok(())
    }

    fn handle_line(&mut self, raw_line_bytes: &[u8]) -> std::io::Result<()> {
        self.ingest_line(raw_line_bytes);

        if self.source == Source::Unknown {
            self.source = detect_source(&self.line);
            // Handle (rare) plain `diff -u file1 file2` header. Done here to avoid having
            // to introduce and handle a Source::DiffUnifiedAmbiguous variant everywhere.
            if self.line.starts_with("--- ") {
                self.minus_line_counter = AmbiguousDiffMinusCounter::prepare_to_count();
            }
        }

        if !self.held_header_rows.is_empty()
            && !handlers::diff_header::continues_file_header(&self.line)
        {
            self.release_held_header_rows()?;
        }

        // Every method named handle_* must return std::io::Result<bool>.
        // The bool indicates whether the line has been handled by that
        // method (in which case no subsequent handlers are permitted to
        // handle it).
        let _ = self.handle_commit_meta_header_line()?
            || self.handle_diff_stat_line()?
            || self.handle_diff_header_diff_line()?
            || self.handle_diff_header_file_operation_line()?
            || self.handle_diff_header_minus_line()?
            || self.handle_diff_header_plus_line()?
            || self.handle_hunk_header_line()?
            || self.handle_diff_header_mode_line()?
            || self.handle_diff_header_misc_line()?
            || self.handle_submodule_log_line()?
            || self.handle_submodule_short_line()?
            || self.handle_merge_conflict_line()?
            || self.handle_hunk_line()?
            || self.handle_git_show_file_line()?
            || self.handle_blame_line()?
            || self.handle_grep_line()?
            || self.should_skip_line()
            || self.emit_line_unchanged()?;
        Ok(())
    }

    /// With --side-by-side=hunk, decide whether the hunk whose header was just read is displayed
    /// side-by-side. Lines read ahead to decide are queued in `lookahead`, to be handled as usual
    /// afterwards.
    fn look_ahead_at_hunk<I>(&mut self, lines: &mut ByteLines<I>, lookahead: &mut VecDeque<Vec<u8>>)
    where
        I: BufRead,
    {
        let State::HunkHeader(_, parsed_hunk_header, _, _) = &self.state else {
            return;
        };
        self.hunk_side_by_side = Some(match parsed_hunk_header.unified_hunk_lengths() {
            Some((minus_length, plus_length)) => {
                hunk_removes_and_adds_lines(minus_length, plus_length, lines, lookahead)
            }
            // A combined diff hunk (merge commit) keeps the configured layout.
            None => self.config.side_by_side,
        });
    }

    fn ingest_line(&mut self, raw_line_bytes: &[u8]) {
        match String::from_utf8(raw_line_bytes.to_vec()) {
            Ok(utf8) => self.ingest_line_utf8(utf8),
            Err(_) => {
                let raw_line = String::from_utf8_lossy(raw_line_bytes);
                let truncated_len = utils::round_char_boundary::floor_char_boundary(
                    &raw_line,
                    self.config.max_line_length,
                );
                self.raw_line = raw_line[..truncated_len].to_string();
                self.line.clone_from(&self.raw_line);
            }
        }
    }

    fn ingest_line_utf8(&mut self, raw_line: String) {
        self.raw_line = raw_line;
        // When a file has \r\n line endings, git sometimes adds ANSI escape sequences between the
        // \r and \n, in which case byte_lines does not remove the \r. Remove it now. [EndCRLF]
        // TODO: Limit the number of characters we examine when looking for the \r?
        if let Some(cr_index) = self.raw_line.rfind('\r') {
            if ansi::measure_text_width(&self.raw_line[cr_index + 1..]) == 0 {
                self.raw_line = format!(
                    "{}{}",
                    &self.raw_line[..cr_index],
                    &self.raw_line[cr_index + 1..]
                );
            }
        }
        if self.config.max_line_length > 0
            && self.raw_line.len() > self.config.max_line_length
            // Do not truncate long hunk headers
            && !self.raw_line.starts_with("@@")
            // Do not truncate ripgrep --json output
            && !self.raw_line.starts_with('{')
        {
            self.raw_line = ansi::truncate_str(
                &self.raw_line,
                self.config.max_line_length,
                &self.config.truncation_symbol,
            )
            .to_string()
        };
        self.line = ansi::strip_ansi_codes(&self.raw_line);
    }

    /// Skip file metadata lines unless a raw diff style has been requested.
    pub fn should_skip_line(&self) -> bool {
        matches!(self.state, State::DiffHeader(_))
            && self.should_handle()
            && !self.config.color_only
    }

    /// Emit unchanged any line that delta does not handle.
    pub fn emit_line_unchanged(&mut self) -> std::io::Result<bool> {
        self.painter.emit()?;
        if self.config.color_only && self.is_file_header_row() {
            let row = format!("{}\n", format_raw_line(&self.raw_line, self.config));
            self.write_color_only_header_row(row.as_bytes())?;
            return Ok(true);
        }
        writeln!(
            self.painter.writer,
            "{}",
            format_raw_line(&self.raw_line, self.config)
        )?;
        let handled_line = true;
        Ok(handled_line)
    }

    fn is_file_header_row(&self) -> bool {
        matches!(self.state, State::DiffHeader(_))
            && (self.line.starts_with("diff ")
                || handlers::diff_header::continues_file_header(&self.line))
    }

    /// Should a handle_* function be called on this element?
    // TODO: I'm not sure the above description is accurate; I think this
    // function needs a more accurate name.
    pub fn should_handle(&self) -> bool {
        let style = self.config.get_style(&self.state);
        !(style.is_raw && style.decoration_style == DecorationStyle::NoDecoration)
    }
}

/// Whether a unified diff hunk, with the given numbers of minus and plus side lines, contains both
/// removed and added lines. Reads the hunk's lines into `lookahead`, but stops as soon as the
/// answer is known: at once if one side is empty (e.g. an added or deleted file), when both kinds
/// of lines have been seen, or at the end of the hunk, so that it never waits for input beyond it.
fn hunk_removes_and_adds_lines<I>(
    minus_length: usize,
    plus_length: usize,
    lines: &mut ByteLines<I>,
    lookahead: &mut VecDeque<Vec<u8>>,
) -> bool
where
    I: BufRead,
{
    let (mut minus_remaining, mut plus_remaining) = (minus_length, plus_length);
    let (mut has_minus, mut has_plus) = (false, false);
    let mut index = 0;
    // Keep reading while each kind of line not yet seen could still come.
    while (has_minus || minus_remaining > 0)
        && (has_plus || plus_remaining > 0)
        && !(has_minus && has_plus)
    {
        if index == lookahead.len() {
            match lines.next() {
                Some(Ok(raw_line_bytes)) => lookahead.push_back(raw_line_bytes.to_vec()),
                _ => break,
            }
        }
        let line = ansi::strip_ansi_codes(&String::from_utf8_lossy(&lookahead[index]));
        index += 1;
        match line.bytes().next() {
            Some(b'-') => {
                has_minus = true;
                minus_remaining = minus_remaining.saturating_sub(1);
            }
            Some(b'+') => {
                has_plus = true;
                plus_remaining = plus_remaining.saturating_sub(1);
            }
            // An empty line is an unchanged line whose trailing space was stripped.
            Some(b' ') | None => {
                minus_remaining = minus_remaining.saturating_sub(1);
                plus_remaining = plus_remaining.saturating_sub(1);
            }
            Some(b'\\') => {} // "\ No newline at end of file"
            Some(_) => break, // Not a hunk line: the hunk is shorter than its header says.
        }
    }
    has_minus && has_plus
}

/// If output is going to a tty, emit hyperlinks if requested.
// Although raw output should basically be emitted unaltered, we do this.
pub fn format_raw_line<'a>(line: &'a str, config: &Config) -> Cow<'a, str> {
    if config.hyperlinks && io::stdout().is_terminal() {
        features::hyperlinks::format_commit_line_with_osc8_commit_hyperlink(line, config)
    } else {
        Cow::from(line)
    }
}

/// Try to detect what is producing the input for delta.
///
/// Currently can detect:
/// * git diff
/// * diff -u
fn detect_source(line: &str) -> Source {
    if line.starts_with("commit ")
        || line.starts_with("diff --git ")
        || line.starts_with("diff --cc ")
        || line.starts_with("diff --combined ")
    {
        Source::GitDiff
    } else if line.starts_with("diff -u")
        || line.starts_with("diff -ru")
        || line.starts_with("diff -r -u")
        || line.starts_with("diff -U")
        || line.starts_with("--- ")
        || line.starts_with("Only in ")
    {
        Source::DiffUnified
    } else {
        Source::Unknown
    }
}