crates/stdx/src/lib.rs

   1 //! Missing batteries for standard libraries.
   2 use std::{cmp::Ordering, ops, time::Instant};
   3
   4 mod macros;
   5 pub mod process;
   6 pub mod panic_context;
   7
   8 pub use always_assert::{always, never};
   9
  10 #[inline(always)]
  11 pub fn is_ci() -> bool {
  12     option_env!("CI").is_some()
  13 }
  14
  15 #[must_use]
  16 pub fn timeit(label: &'static str) -> impl Drop {
  17     let start = Instant::now();
  18     defer(move || eprintln!("{}: {:.2?}", label, start.elapsed()))
  19 }
  20
  21 /// Prints backtrace to stderr, useful for debugging.
  22 #[cfg(feature = "backtrace")]
  23 pub fn print_backtrace() {
  24     let bt = backtrace::Backtrace::new();
  25     eprintln!("{:?}", bt);
  26 }
  27 #[cfg(not(feature = "backtrace"))]
  28 pub fn print_backtrace() {
  29     eprintln!(
  30         r#"Enable the backtrace feature.
  31 Uncomment `default = [ "backtrace" ]` in `crates/stdx/Cargo.toml`.
  32 "#
  33     );
  34 }
  35
  36 pub fn to_lower_snake_case(s: &str) -> String {
  37     to_snake_case(s, char::to_ascii_lowercase)
  38 }
  39 pub fn to_upper_snake_case(s: &str) -> String {
  40     to_snake_case(s, char::to_ascii_uppercase)
  41 }
  42 fn to_snake_case<F: Fn(&char) -> char>(s: &str, change_case: F) -> String {
  43     let mut buf = String::with_capacity(s.len());
  44     let mut prev = false;
  45     for c in s.chars() {
  46         // `&& prev` is required to not insert `_` before the first symbol.
  47         if c.is_ascii_uppercase() && prev {
  48             // This check is required to not translate `Weird_Case` into `weird__case`.
  49             if !buf.ends_with('_') {
  50                 buf.push('_')
  51             }
  52         }
  53         prev = true;
  54
  55         buf.push(change_case(&c));
  56     }
  57     buf
  58 }
  59
  60 pub fn replace(buf: &mut String, from: char, to: &str) {
  61     if !buf.contains(from) {
  62         return;
  63     }
  64     // FIXME: do this in place.
  65     *buf = buf.replace(from, to)
  66 }
  67
  68 pub fn trim_indent(mut text: &str) -> String {
  69     if text.starts_with('\n') {
  70         text = &text[1..];
  71     }
  72     let indent = text
  73         .lines()
  74         .filter(|it| !it.trim().is_empty())
  75         .map(|it| it.len() - it.trim_start().len())
  76         .min()
  77         .unwrap_or(0);
  78     text.split_inclusive('\n')
  79         .map(
  80             |line| {
  81                 if line.len() <= indent {
  82                     line.trim_start_matches(' ')
  83                 } else {
  84                     &line[indent..]
  85                 }
  86             },
  87         )
  88         .collect()
  89 }
  90
  91 pub fn equal_range_by<T, F>(slice: &[T], mut key: F) -> ops::Range<usize>
  92 where
  93     F: FnMut(&T) -> Ordering,
  94 {
  95     let start = slice.partition_point(|it| key(it) == Ordering::Less);
  96     let len = slice[start..].partition_point(|it| key(it) == Ordering::Equal);
  97     start..start + len
  98 }
  99
 100 #[must_use]
 101 pub fn defer<F: FnOnce()>(f: F) -> impl Drop {
 102     struct D<F: FnOnce()>(Option<F>);
 103     impl<F: FnOnce()> Drop for D<F> {
 104         fn drop(&mut self) {
 105             if let Some(f) = self.0.take() {
 106                 f()
 107             }
 108         }
 109     }
 110     D(Some(f))
 111 }
 112
 113 #[cfg_attr(not(target_arch = "wasm32"), repr(transparent))]
 114 pub struct JodChild(pub std::process::Child);
 115
 116 impl ops::Deref for JodChild {
 117     type Target = std::process::Child;
 118     fn deref(&self) -> &std::process::Child {
 119         &self.0
 120     }
 121 }
 122
 123 impl ops::DerefMut for JodChild {
 124     fn deref_mut(&mut self) -> &mut std::process::Child {
 125         &mut self.0
 126     }
 127 }
 128
 129 impl Drop for JodChild {
 130     fn drop(&mut self) {
 131         let _ = self.0.kill();
 132         let _ = self.0.wait();
 133     }
 134 }
 135
 136 impl JodChild {
 137     pub fn into_inner(self) -> std::process::Child {
 138         if cfg!(target_arch = "wasm32") {
 139             panic!("no processes on wasm");
 140         }
 141         // SAFETY: repr transparent, except on WASM
 142         unsafe { std::mem::transmute::<JodChild, std::process::Child>(self) }
 143     }
 144 }
 145
 146 // feature: iter_order_by
 147 // Iterator::eq_by
 148 pub fn iter_eq_by<I, I2, F>(this: I2, other: I, mut eq: F) -> bool
 149 where
 150     I: IntoIterator,
 151     I2: IntoIterator,
 152     F: FnMut(I2::Item, I::Item) -> bool,
 153 {
 154     let mut other = other.into_iter();
 155     let mut this = this.into_iter();
 156
 157     loop {
 158         let x = match this.next() {
 159             None => return other.next().is_none(),
 160             Some(val) => val,
 161         };
 162
 163         let y = match other.next() {
 164             None => return false,
 165             Some(val) => val,
 166         };
 167
 168         if !eq(x, y) {
 169             return false;
 170         }
 171     }
 172 }
 173
 174 #[cfg(test)]
 175 mod tests {
 176     use super::*;
 177
 178     #[test]
 179     fn test_trim_indent() {
 180         assert_eq!(trim_indent(""), "");
 181         assert_eq!(
 182             trim_indent(
 183                 "
 184             hello
 185             world
 186 "
 187             ),
 188             "hello\nworld\n"
 189         );
 190         assert_eq!(
 191             trim_indent(
 192                 "
 193             hello
 194             world"
 195             ),
 196             "hello\nworld"
 197         );
 198         assert_eq!(trim_indent("    hello\n    world\n"), "hello\nworld\n");
 199         assert_eq!(
 200             trim_indent(
 201                 "
 202             fn main() {
 203                 return 92;
 204             }
 205         "
 206             ),
 207             "fn main() {\n    return 92;\n}\n"
 208         );
 209     }
 210 }