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
use std::borrow::Cow;
use widestring::WideStr;
use crate::{
err::{BindingErrorCode, ErrorKind, RegexError, Result},
tre, RegApproxMatch, RegApproxParams, Regex, RegexecFlags,
};
pub type RegApproxMatchWideStr<'a> = RegApproxMatch<&'a WideStr, Cow<'a, WideStr>>;
impl Regex {
/// Performs an approximate regex search on the passed wide string, returning `nmatches`
/// results.
///
/// This function should only be used if you need to match raw wide string. Otherwise,
/// [`regaexec`] is recommended instead.
///
/// # Arguments
/// * `string`: [`WideStr`] to match against `compiled_reg`
/// * `params`: see [`RegApproxParams`]
/// * `nmatches`: number of matches to return
/// * `flags`: [`RegexecFlags`] to pass to [`tre_reganexec`](tre_regex_sys::tre_reganexec).
///
/// # Returns
/// If no error was found, a [`Vec`] of [`Option`]s will be returned.
///
/// If a given match index is empty, The `Option` will be `None`. Otherwise, a [`WideStr`] will
/// be returned.
///
/// # Errors
/// If an error is encountered during matching, it returns a [`RegexError`].
///
/// # Caveats
/// Unless copied, the match results must live at least as long as `string`. This is because they are
/// slices into `string` under the hood, for efficiency.
///
/// # Examples
/// ```
/// # use tre_regex::Result;
/// # fn main() -> Result<()> {
/// use tre_regex::{RegcompFlags, RegexecFlags, RegApproxParams, Regex};
/// use widestring::widestr;
///
/// let regcomp_flags = RegcompFlags::new()
/// .add(RegcompFlags::EXTENDED)
/// .add(RegcompFlags::ICASE);
/// let regaexec_flags = RegexecFlags::new().add(RegexecFlags::NONE);
/// let regaexec_params = RegApproxParams::new()
/// .cost_ins(1)
/// .cost_del(1)
/// .cost_subst(1)
/// .max_cost(2)
/// .max_del(2)
/// .max_ins(2)
/// .max_subst(2)
/// .max_err(2);
///
/// let compiled_reg = Regex::new_wide(widestr!("^(hello).*(world)$"), regcomp_flags)?;
/// let result = compiled_reg.regawexec(
/// widestr!("hello world"), // Bytes to match against
/// ®aexec_params, // Matching parameters
/// 3, // Number of matches we want
/// regaexec_flags // Flags
/// )?;
///
/// for (i, matched) in result.get_matches().into_iter().enumerate() {
/// match matched {
/// Some(substr) => println!("Match {i}: {}", substr.display()),
/// None => println!("Match {i}: <None>"),
/// }
/// }
/// # Ok(())
/// # }
/// ```
///
/// [`regaexec`]: crate::Regex::regaexec
pub fn regawexec<'a>(
&self,
string: &'a WideStr,
params: &RegApproxParams,
nmatches: usize,
flags: RegexecFlags,
) -> Result<RegApproxMatchWideStr<'a>> {
let Some(compiled_reg_obj) = self.get() else {
return Err(RegexError::new(
ErrorKind::Binding(BindingErrorCode::REGEX_VACANT),
"Attempted to unwrap a vacant Regex object"
));
};
let mut match_vec: Vec<tre::regmatch_t> =
vec![tre::regmatch_t { rm_so: 0, rm_eo: 0 }; nmatches];
let mut amatch = tre::regamatch_t {
nmatch: nmatches,
pmatch: match_vec.as_mut_ptr(),
..Default::default()
};
// SAFETY: compiled_reg is a wrapped type (see safety concerns for Regex). string is read-only.
// match_vec has enough room for everything. flags also cannot wrap around.
#[allow(clippy::cast_possible_wrap)]
let result = unsafe {
tre::tre_regawnexec(
compiled_reg_obj,
string.as_ptr() as *const _,
string.len(),
&mut amatch,
*params.get(),
flags.get(),
)
};
if result != 0 {
return Err(self.regerror(result));
}
let mut result: Vec<Option<Cow<'a, WideStr>>> = Vec::with_capacity(nmatches);
for pmatch in match_vec {
if pmatch.rm_so < 0 || pmatch.rm_eo < 0 {
result.push(None);
continue;
}
// Wraparound is impossible.
#[allow(clippy::cast_sign_loss)]
let start_offset = pmatch.rm_so as usize;
#[allow(clippy::cast_sign_loss)]
let end_offset = pmatch.rm_eo as usize;
result.push(Some(Cow::Borrowed(&string[start_offset..end_offset])));
}
Ok(RegApproxMatchWideStr::new(string, result, amatch))
}
}
/// Performs an approximate regex search on the passed wide string, returning `nmatches` results.
///
/// This is a thin wrapper around [`Regex::regawexec`].
///
/// Non-matching subexpressions or patterns will return `None` in the results.
///
/// # Arguments
/// * `compiled_reg`: the compiled [`Regex`] object.
/// * `string`: [`WideStr`] to match against `compiled_reg`
/// * `params`: see [`RegApproxParams`]
/// * `nmatches`: number of matches to return
/// * `flags`: [`RegexecFlags`] to pass to [`tre_regnexec`](tre_regex_sys::tre_regnexec).
///
/// # Returns
/// If no error was found, a [`Vec`] of [`Option`]s will be returned.
///
/// If a given match index is empty, The `Option` will be `None`. Otherwise, a [`WideStr`] will be
/// returned.
///
/// # Errors
/// If an error is encountered during matching, it returns a [`RegexError`].
///
/// # Caveats
/// Unless copied, the match results must live at least as long as `string`. This is because they
/// are slices into `string` under the hood, for efficiency.
///
/// # Examples
/// ```
/// # use tre_regex::Result;
/// # fn main() -> Result<()> {
/// use tre_regex::{RegcompFlags, RegexecFlags, RegApproxParams, Regex, regawexec};
/// use widestring::widestr;
///
/// let regcomp_flags = RegcompFlags::new()
/// .add(RegcompFlags::EXTENDED)
/// .add(RegcompFlags::ICASE);
/// let regaexec_flags = RegexecFlags::new().add(RegexecFlags::NONE);
/// let regaexec_params = RegApproxParams::new()
/// .cost_ins(1)
/// .cost_del(1)
/// .cost_subst(1)
/// .max_cost(2)
/// .max_del(2)
/// .max_ins(2)
/// .max_subst(2)
/// .max_err(2);
///
/// let compiled_reg = Regex::new_wide(widestr!("^(hello).*(world)$"), regcomp_flags)?;
/// let result = regawexec(
/// &compiled_reg, // Compiled regex
/// widestr!("hello world"), // String to match against
/// ®aexec_params, // Matching parameters
/// 3, // Number of matches we want
/// regaexec_flags // Flags
/// )?;
///
/// for (i, matched) in result.get_matches().into_iter().enumerate() {
/// match matched {
/// Some(substr) => println!("Match {i}: {}", substr.display()),
/// None => println!("Match {i}: <None>"),
/// }
/// }
/// # Ok(())
/// # }
/// ```
#[inline]
pub fn regawexec<'a>(
compiled_reg: &Regex,
string: &'a WideStr,
params: &RegApproxParams,
nmatches: usize,
flags: RegexecFlags,
) -> Result<RegApproxMatchWideStr<'a>> {
compiled_reg.regawexec(string, params, nmatches, flags)
}