gix_merge/blob/platform/
mod.rs

1use crate::blob::{pipeline, BuiltinDriver, Pipeline, Platform};
2use bstr::{BStr, BString};
3use gix_filter::attributes;
4
5/// A stored value representing a resource that participates in a merge.
6#[derive(Clone, Eq, PartialEq, Ord, PartialOrd, Debug)]
7pub(super) struct Resource {
8    /// The `id` of the value, or `null` if it's only living in a worktree.
9    id: gix_hash::ObjectId,
10    /// The repository-relative path where the resource lives in the tree.
11    rela_path: BString,
12    /// The outcome of converting a resource into a mergable format using [Pipeline::convert_to_mergeable()].
13    data: Option<pipeline::Data>,
14    /// The kind of the resource we are looking at. Only possible values are `Blob` and `BlobExecutable`.
15    mode: gix_object::tree::EntryKind,
16    /// A possibly empty buffer, depending on `conversion.data` which may indicate the data is considered binary
17    /// or the resource doesn't exist.
18    buffer: Vec<u8>,
19}
20
21/// A blob or executable ready to be merged in one way or another.
22#[derive(Copy, Clone, Ord, PartialOrd, Eq, PartialEq, Hash)]
23pub struct ResourceRef<'a> {
24    /// The data itself, suitable for merging, and if the object or worktree item is present at all.
25    pub data: resource::Data<'a>,
26    /// The location of the resource, relative to the working tree.
27    pub rela_path: &'a BStr,
28    /// The id of the content as it would be stored in `git`, or `null` if the content doesn't exist anymore at
29    /// `rela_path` or if it was never computed. This can happen with content read from the worktree, which
30    /// after its 'to-git' conversion never had its hash computed.
31    pub id: &'a gix_hash::oid,
32}
33
34/// Options for use in [`Platform::new()`].
35#[derive(Default, Clone, PartialEq, Eq, Debug, Hash, Ord, PartialOrd)]
36pub struct Options {
37    /// Define which driver to use by name if the `merge` attribute for a resource is unspecified.
38    ///
39    /// This is the value of the `merge.default` git configuration.
40    pub default_driver: Option<BString>,
41}
42
43/// The selection of the driver to use by a resource obtained with [`Platform::prepare_merge()`].
44///
45/// If available, an index into the `drivers` field to access more diff-related information of the driver for items
46/// at the given path, as previously determined by git-attributes.
47///
48/// * `merge` is set
49///     - Use the [`BuiltinDriver::Text`]
50/// * `-merge` is unset
51///     - Use the [`BuiltinDriver::Binary`]
52/// * `!merge` is unspecified
53///     - Use [`Options::default_driver`] or [`BuiltinDriver::Text`].
54/// * `merge=name`
55///     - Search for a user-configured or built-in driver called `name`.
56///     - If not found, silently default to [`BuiltinDriver::Text`]
57///
58/// Note that drivers are queried even if there is no object available.
59#[derive(Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Debug, Hash)]
60pub enum DriverChoice {
61    /// Use the given built-in driver to perform the merge.
62    BuiltIn(BuiltinDriver),
63    /// Use the user-provided driver program using the index into [the platform drivers array](Platform::drivers()).
64    Index(usize),
65}
66
67impl Default for DriverChoice {
68    fn default() -> Self {
69        DriverChoice::BuiltIn(Default::default())
70    }
71}
72
73/// Lifecycle
74impl Platform {
75    /// Create a new instance with a way to `filter` data from the object database and turn it into something that is merge-able.
76    /// `filter_mode` decides how to do that specifically.
77    /// Use `attr_stack` to access attributes pertaining worktree filters and merge settings.
78    /// `drivers` are the list of available merge drivers that individual paths can refer to by means of git attributes.
79    /// `options` further configure the operation.
80    pub fn new(
81        filter: Pipeline,
82        filter_mode: pipeline::Mode,
83        attr_stack: gix_worktree::Stack,
84        mut drivers: Vec<super::Driver>,
85        options: Options,
86    ) -> Self {
87        drivers.sort_by(|a, b| a.name.cmp(&b.name));
88        Platform {
89            drivers,
90            current: None,
91            ancestor: None,
92            other: None,
93            filter,
94            filter_mode,
95            attr_stack,
96            attrs: {
97                let mut out = attributes::search::Outcome::default();
98                out.initialize_with_selection(&Default::default(), ["merge", "conflict-marker-size"]);
99                out
100            },
101            options,
102        }
103    }
104}
105
106/// Access
107impl Platform {
108    /// Return all drivers that this instance was initialized with.
109    ///
110    /// They are sorted by [`name`](super::Driver::name) to support binary searches.
111    pub fn drivers(&self) -> &[super::Driver] {
112        &self.drivers
113    }
114}
115
116///
117pub mod set_resource;
118
119///
120pub mod resource;
121
122///
123pub mod merge;
124pub use merge::inner::{builtin_merge, prepare_external_driver};
125
126///
127pub mod prepare_merge;
gix_merge/blob/platform/mod.rs

gix_merge/blob/platform/
mod.rs
