onig/
utils.rs

1use std::ffi::{CStr, CString};
2use std::mem;
3
4/// Get Version
5///
6/// Returns the version information for the underlying Oniguruma
7/// API. This is separate from the Rust Onig and onig_sys versions.
8pub fn version() -> String {
9    let raw_version = unsafe { CStr::from_ptr(onig_sys::onig_version()) };
10    raw_version.to_string_lossy().into_owned()
11}
12
13/// Get Copyright
14///
15/// Returns copyright information for the underlying Oniguruma
16/// API. Rust onig is licensed seperately. For more information see
17/// LICENSE.md in the source distribution.
18pub fn copyright() -> String {
19    let raw_copy = unsafe { CStr::from_ptr(onig_sys::onig_copyright()) };
20    raw_copy.to_string_lossy().into_owned()
21}
22
23pub type CodePointRange = (onig_sys::OnigCodePoint, onig_sys::OnigCodePoint);
24
25/// Create a User Defined Proeprty
26///
27/// Creates a new user defined property from the given OnigCodePoint vlaues.
28pub fn define_user_property(name: &str, ranges: &[CodePointRange]) -> i32 {
29    let mut raw_ranges = vec![ranges.len() as onig_sys::OnigCodePoint];
30    for &(start, end) in ranges {
31        raw_ranges.push(start);
32        raw_ranges.push(end);
33    }
34    let name = CString::new(name).unwrap();
35    let r = unsafe {
36        onig_sys::onig_unicode_define_user_property(name.as_ptr(), raw_ranges.as_mut_ptr())
37    };
38
39    // Deliberately leak the memory here as Onig expects to be able to
40    // hang on to the pointer we just gave it. I'm not happy about it
41    // but this does work and the amounts of memory leaked should be
42    // trivial.
43    mem::forget(raw_ranges);
44    r
45}
46
47#[cfg(test)]
48mod tests {
49    use super::*;
50
51    #[test]
52    pub fn utils_get_copyright_is_not_emtpy() {
53        let copyright = copyright();
54        assert!(copyright.len() > 0);
55    }
56}