|
| 1 | +use std::ffi::CString; |
| 2 | +use std::ptr; |
| 3 | + |
| 4 | +use crate::util::Binding; |
| 5 | +use crate::{raw, Buf, Commit, DiffFindOptions, DiffOptions, Error, IntoCString}; |
| 6 | +use crate::{Diff, Oid, Signature}; |
| 7 | + |
| 8 | +/// A structure to represent patch in mbox format for sending via email |
| 9 | +pub struct Email { |
| 10 | + /// Buffer to store the e-mail patch in |
| 11 | + pub buf: Buf, |
| 12 | +} |
| 13 | + |
| 14 | +/// Options for controlling the formatting of the generated e-mail. |
| 15 | +pub struct EmailCreateOptions { |
| 16 | + subject_prefix: Option<CString>, |
| 17 | + raw: raw::git_email_create_options, |
| 18 | +} |
| 19 | + |
| 20 | +impl Default for EmailCreateOptions { |
| 21 | + fn default() -> Self { |
| 22 | + // Defaults options created in corresponding to `GIT_EMAIL_CREATE_OPTIONS_INIT` |
| 23 | + let mut diff_opts = DiffOptions::new(); |
| 24 | + diff_opts.show_binary(true).context_lines(3); |
| 25 | + unsafe { |
| 26 | + let default_options = raw::git_email_create_options { |
| 27 | + version: raw::GIT_EMAIL_CREATE_OPTIONS_VERSION, |
| 28 | + flags: raw::GIT_EMAIL_CREATE_DEFAULT as u32, |
| 29 | + diff_opts: ptr::read(diff_opts.raw()), |
| 30 | + diff_find_opts: ptr::read(DiffFindOptions::new().raw()), |
| 31 | + subject_prefix: ptr::null(), |
| 32 | + start_number: 1, |
| 33 | + reroll_number: 0, |
| 34 | + }; |
| 35 | + Self { |
| 36 | + subject_prefix: None, |
| 37 | + raw: default_options, |
| 38 | + } |
| 39 | + } |
| 40 | + } |
| 41 | +} |
| 42 | + |
| 43 | +impl EmailCreateOptions { |
| 44 | + /// Creates a new set of email create options |
| 45 | + /// |
| 46 | + /// By default, options include rename detection and binary |
| 47 | + /// diffs to match `git format-patch`. |
| 48 | + pub fn new() -> Self { |
| 49 | + Self::default() |
| 50 | + } |
| 51 | + |
| 52 | + fn flag(&mut self, opt: raw::git_email_create_flags_t, val: bool) -> &mut Self { |
| 53 | + let opt = opt as u32; |
| 54 | + if val { |
| 55 | + self.raw.flags |= opt; |
| 56 | + } else { |
| 57 | + self.raw.flags &= !opt; |
| 58 | + } |
| 59 | + self |
| 60 | + } |
| 61 | + |
| 62 | + /// Flag indicating whether patch numbers are included in the subject prefix. |
| 63 | + pub fn omit_numbers(&mut self, omit: bool) -> &mut Self { |
| 64 | + self.flag(raw::GIT_EMAIL_CREATE_OMIT_NUMBERS, omit) |
| 65 | + } |
| 66 | + |
| 67 | + /// Flag indicating whether numbers included in the subject prefix even when |
| 68 | + /// the patch is for a single commit (1/1). |
| 69 | + pub fn always_number(&mut self, always: bool) -> &mut Self { |
| 70 | + self.flag(raw::GIT_EMAIL_CREATE_ALWAYS_NUMBER, always) |
| 71 | + } |
| 72 | + |
| 73 | + /// Flag indicating whether rename or similarity detection are ignored. |
| 74 | + pub fn ignore_renames(&mut self, ignore: bool) -> &mut Self { |
| 75 | + self.flag(raw::GIT_EMAIL_CREATE_NO_RENAMES, ignore) |
| 76 | + } |
| 77 | + |
| 78 | + /// Set `DiffOptions` to use when creating diffs |
| 79 | + pub fn diff_options(&mut self, diff_opts: &mut DiffOptions) -> &mut Self { |
| 80 | + self.raw.diff_opts = unsafe { ptr::read(diff_opts.raw()) }; |
| 81 | + self |
| 82 | + } |
| 83 | + |
| 84 | + /// Set `DiffFindOptions` for finding similarities within diffs |
| 85 | + pub fn diff_find_options(&mut self, diff_find_opts: &mut DiffFindOptions) -> &mut Self { |
| 86 | + self.raw.diff_find_opts = unsafe { ptr::read(diff_find_opts.raw()) }; |
| 87 | + self |
| 88 | + } |
| 89 | + |
| 90 | + /// Set the subject prefix |
| 91 | + /// |
| 92 | + /// The default value for this is "PATCH". If set to an empty string ("") |
| 93 | + /// then only the patch numbers will be shown in the prefix. |
| 94 | + /// If the subject_prefix is empty and patch numbers are not being shown, |
| 95 | + /// the prefix will be omitted entirely. |
| 96 | + pub fn subject_prefix<T: IntoCString>(&mut self, t: T) -> &mut Self { |
| 97 | + self.subject_prefix = Some(t.into_c_string().unwrap()); |
| 98 | + self |
| 99 | + } |
| 100 | + |
| 101 | + /// Set the starting patch number; this cannot be 0. |
| 102 | + /// |
| 103 | + /// The default value for this is 1. |
| 104 | + pub fn start_number(&mut self, number: usize) -> &mut Self { |
| 105 | + self.raw.start_number = number; |
| 106 | + self |
| 107 | + } |
| 108 | + |
| 109 | + /// Set the "re-roll" number. |
| 110 | + /// |
| 111 | + /// The default value for this is 0 (no re-roll). |
| 112 | + pub fn reroll_number(&mut self, number: usize) -> &mut Self { |
| 113 | + self.raw.reroll_number = number; |
| 114 | + self |
| 115 | + } |
| 116 | + |
| 117 | + /// Acquire a pointer to the underlying raw options. |
| 118 | + /// |
| 119 | + /// This function is unsafe as the pointer is only valid so long as this |
| 120 | + /// structure is not moved, modified, or used elsewhere. |
| 121 | + unsafe fn raw(&mut self) -> *const raw::git_email_create_options { |
| 122 | + self.raw.subject_prefix = self |
| 123 | + .subject_prefix |
| 124 | + .as_ref() |
| 125 | + .map(|s| s.as_ptr()) |
| 126 | + .unwrap_or(ptr::null()); |
| 127 | + &self.raw as *const _ |
| 128 | + } |
| 129 | +} |
| 130 | + |
| 131 | +impl Email { |
| 132 | + /// Create a diff for a commit in mbox format for sending via email. |
| 133 | + pub fn from_diff<T: IntoCString>( |
| 134 | + diff: &Diff<'_>, |
| 135 | + patch_idx: usize, |
| 136 | + patch_count: usize, |
| 137 | + commit_id: &Oid, |
| 138 | + summary: T, |
| 139 | + body: T, |
| 140 | + author: &Signature<'_>, |
| 141 | + opts: &mut EmailCreateOptions, |
| 142 | + ) -> Result<Self, Error> { |
| 143 | + let buf = Buf::new(); |
| 144 | + unsafe { |
| 145 | + try_call!(raw::git_email_create_from_diff( |
| 146 | + buf.raw(), |
| 147 | + Binding::raw(diff), |
| 148 | + patch_idx, |
| 149 | + patch_count, |
| 150 | + Binding::raw(commit_id), |
| 151 | + summary.into_c_string()?.as_ptr(), |
| 152 | + body.into_c_string()?.as_ptr(), |
| 153 | + Binding::raw(author), |
| 154 | + opts.raw() |
| 155 | + )); |
| 156 | + Ok(Self { buf }) |
| 157 | + } |
| 158 | + } |
| 159 | + |
| 160 | + /// Create a diff for a commit in mbox format for sending via email. |
| 161 | + /// The commit must not be a merge commit. |
| 162 | + pub fn from_commit(commit: &Commit<'_>, opts: &mut EmailCreateOptions) -> Result<Self, Error> { |
| 163 | + let buf = Buf::new(); |
| 164 | + unsafe { |
| 165 | + try_call!(raw::git_email_create_from_commit( |
| 166 | + buf.raw(), |
| 167 | + commit.raw(), |
| 168 | + opts.raw() |
| 169 | + )); |
| 170 | + Ok(Self { buf }) |
| 171 | + } |
| 172 | + } |
| 173 | +} |
0 commit comments