gix_merge/blob/builtin_driver/text/
mod.rs

1use bstr::BStr;
2use std::num::NonZeroU8;
3
4/// The way the built-in [text driver](crate::blob::BuiltinDriver::Text) will express
5/// merge conflicts in the resulting file.
6#[derive(Default, Copy, Clone, Debug, Eq, PartialEq, Ord, PartialOrd, Hash)]
7pub enum ConflictStyle {
8    /// Only show the zealously minified conflicting lines of the local changes and the incoming (other) changes,
9    /// hiding the base version entirely.
10    ///
11    /// ```text
12    /// line1-changed-by-both
13    /// <<<<<<< local
14    /// line2-to-be-changed-in-incoming
15    /// =======
16    /// line2-changed
17    /// >>>>>>> incoming
18    /// ```
19    #[default]
20    Merge,
21    /// Show non-minimized hunks of local changes, the base, and the incoming (other) changes.
22    ///
23    /// This mode does not hide any information.
24    ///
25    /// ```text
26    /// <<<<<<< local
27    /// line1-changed-by-both
28    /// line2-to-be-changed-in-incoming
29    /// ||||||| 9a8d80c
30    /// line1-to-be-changed-by-both
31    /// line2-to-be-changed-in-incoming
32    /// =======
33    /// line1-changed-by-both
34    /// line2-changed
35    /// >>>>>>> incoming
36    /// ```
37    Diff3,
38    /// Like [`Diff3](Self::Diff3), but will show *minimized* hunks of local change and the incoming (other) changes,
39    /// as well as non-minimized hunks of the base.
40    ///
41    /// ```text
42    /// line1-changed-by-both
43    /// <<<<<<< local
44    /// line2-to-be-changed-in-incoming
45    /// ||||||| 9a8d80c
46    /// line1-to-be-changed-by-both
47    /// line2-to-be-changed-in-incoming
48    /// =======
49    /// line2-changed
50    /// >>>>>>> incoming
51    /// ```
52    ZealousDiff3,
53}
54
55/// The set of labels to annotate conflict markers with.
56///
57/// That way it becomes clearer where the content of conflicts are originating from.
58#[derive(Default, Copy, Clone, Debug, Eq, PartialEq)]
59pub struct Labels<'a> {
60    /// The label for the common *ancestor*.
61    pub ancestor: Option<&'a BStr>,
62    /// The label for the *current* (or *our*) side.
63    pub current: Option<&'a BStr>,
64    /// The label for the *other* (or *their*) side.
65    pub other: Option<&'a BStr>,
66}
67
68/// Options for the builtin [text driver](crate::blob::BuiltinDriver::Text).
69#[derive(Copy, Clone, Debug, Eq, PartialEq)]
70pub struct Options {
71    /// Determine of the diff will be performed.
72    /// Defaults to [`imara_diff::Algorithm::Myers`].
73    pub diff_algorithm: imara_diff::Algorithm,
74    /// Decide what to do to automatically resolve conflicts, or to keep them.
75    pub conflict: Conflict,
76}
77
78impl Default for Options {
79    fn default() -> Self {
80        Options {
81            conflict: Default::default(),
82            diff_algorithm: imara_diff::Algorithm::Myers,
83        }
84    }
85}
86
87/// What to do to resolve a conflict.
88#[derive(Copy, Clone, Debug, Eq, PartialEq, Ord, PartialOrd, Hash)]
89pub enum Conflict {
90    /// Keep the conflict by marking it in the source file.
91    Keep {
92        /// How to visualize conflicts in merged files.
93        style: ConflictStyle,
94        /// The amount of markers to draw, defaults to 7, i.e. `<<<<<<<`
95        marker_size: NonZeroU8,
96    },
97    /// Chose our side to resolve a conflict.
98    ResolveWithOurs,
99    /// Chose their side to resolve a conflict.
100    ResolveWithTheirs,
101    /// Place our and their lines one after another, in any order
102    ResolveWithUnion,
103}
104
105impl Conflict {
106    /// The amount of conflict marker characters to print by default.
107    // TODO: use NonZeroU8::new().unwrap() here once the MSRV supports it.
108    pub const DEFAULT_MARKER_SIZE: u8 = 7;
109
110    /// The amount of conflict markers to print if this instance contains them, or `None` otherwise
111    pub fn marker_size(&self) -> Option<u8> {
112        match self {
113            Conflict::Keep { marker_size, .. } => Some(marker_size.get()),
114            Conflict::ResolveWithOurs | Conflict::ResolveWithTheirs | Conflict::ResolveWithUnion => None,
115        }
116    }
117}
118
119impl Default for Conflict {
120    fn default() -> Self {
121        Conflict::Keep {
122            style: Default::default(),
123            marker_size: Conflict::DEFAULT_MARKER_SIZE.try_into().unwrap(),
124        }
125    }
126}
127
128pub(super) mod function;
129mod utils;
gix_merge/blob/builtin_driver/text/mod.rs

gix_merge/blob/builtin_driver/text/
mod.rs
