1pub mod arc_cow;
2pub mod archive;
3pub mod command;
4pub mod fs;
5pub mod markdown;
6pub mod paths;
7pub mod redact;
8pub mod schemars;
9pub mod serde;
10pub mod shell_env;
11pub mod size;
12#[cfg(any(test, feature = "test-support"))]
13pub mod test;
14pub mod time;
15
16use anyhow::Result;
17use futures::Future;
18use itertools::Either;
19use regex::Regex;
20use std::sync::{LazyLock, OnceLock};
21use std::{
22 borrow::Cow,
23 cmp::{self, Ordering},
24 env,
25 ops::{AddAssign, Range, RangeInclusive},
26 panic::Location,
27 pin::Pin,
28 task::{Context, Poll},
29 time::Instant,
30};
31use unicase::UniCase;
32
33pub use take_until::*;
34#[cfg(any(test, feature = "test-support"))]
35pub use util_macros::{line_endings, path, uri};
36
37#[macro_export]
38macro_rules! debug_panic {
39 ( $($fmt_arg:tt)* ) => {
40 if cfg!(debug_assertions) {
41 panic!( $($fmt_arg)* );
42 } else {
43 let backtrace = std::backtrace::Backtrace::capture();
44 log::error!("{}\n{:?}", format_args!($($fmt_arg)*), backtrace);
45 }
46 };
47}
48
49pub fn truncate(s: &str, max_chars: usize) -> &str {
50 match s.char_indices().nth(max_chars) {
51 None => s,
52 Some((idx, _)) => &s[..idx],
53 }
54}
55
56/// Removes characters from the end of the string if its length is greater than `max_chars` and
57/// appends "..." to the string. Returns string unchanged if its length is smaller than max_chars.
58pub fn truncate_and_trailoff(s: &str, max_chars: usize) -> String {
59 debug_assert!(max_chars >= 5);
60
61 // If the string's byte length is <= max_chars, walking the string can be skipped since the
62 // number of chars is <= the number of bytes.
63 if s.len() <= max_chars {
64 return s.to_string();
65 }
66 let truncation_ix = s.char_indices().map(|(i, _)| i).nth(max_chars);
67 match truncation_ix {
68 Some(index) => s[..index].to_string() + "β¦",
69 _ => s.to_string(),
70 }
71}
72
73/// Removes characters from the front of the string if its length is greater than `max_chars` and
74/// prepends the string with "...". Returns string unchanged if its length is smaller than max_chars.
75pub fn truncate_and_remove_front(s: &str, max_chars: usize) -> String {
76 debug_assert!(max_chars >= 5);
77
78 // If the string's byte length is <= max_chars, walking the string can be skipped since the
79 // number of chars is <= the number of bytes.
80 if s.len() <= max_chars {
81 return s.to_string();
82 }
83 let suffix_char_length = max_chars.saturating_sub(1);
84 let truncation_ix = s
85 .char_indices()
86 .map(|(i, _)| i)
87 .nth_back(suffix_char_length);
88 match truncation_ix {
89 Some(index) if index > 0 => "β¦".to_string() + &s[index..],
90 _ => s.to_string(),
91 }
92}
93
94/// Takes only `max_lines` from the string and, if there were more than `max_lines-1`, appends a
95/// a newline and "..." to the string, so that `max_lines` are returned.
96/// Returns string unchanged if its length is smaller than max_lines.
97pub fn truncate_lines_and_trailoff(s: &str, max_lines: usize) -> String {
98 let mut lines = s.lines().take(max_lines).collect::<Vec<_>>();
99 if lines.len() > max_lines - 1 {
100 lines.pop();
101 lines.join("\n") + "\nβ¦"
102 } else {
103 lines.join("\n")
104 }
105}
106
107/// Truncates the string at a character boundary, such that the result is less than `max_bytes` in
108/// length.
109pub fn truncate_to_byte_limit(s: &str, max_bytes: usize) -> &str {
110 if s.len() < max_bytes {
111 return s;
112 }
113
114 for i in (0..max_bytes).rev() {
115 if s.is_char_boundary(i) {
116 return &s[..i];
117 }
118 }
119
120 ""
121}
122
123/// Takes a prefix of complete lines which fit within the byte limit. If the first line is longer
124/// than the limit, truncates at a character boundary.
125pub fn truncate_lines_to_byte_limit(s: &str, max_bytes: usize) -> &str {
126 if s.len() < max_bytes {
127 return s;
128 }
129
130 for i in (0..max_bytes).rev() {
131 if s.is_char_boundary(i) && s.as_bytes()[i] == b'\n' {
132 // Since the i-th character is \n, valid to slice at i + 1.
133 return &s[..i + 1];
134 }
135 }
136
137 truncate_to_byte_limit(s, max_bytes)
138}
139
140#[test]
141fn test_truncate_lines_to_byte_limit() {
142 let text = "Line 1\nLine 2\nLine 3\nLine 4";
143
144 // Limit that includes all lines
145 assert_eq!(truncate_lines_to_byte_limit(text, 100), text);
146
147 // Exactly the first line
148 assert_eq!(truncate_lines_to_byte_limit(text, 7), "Line 1\n");
149
150 // Limit between lines
151 assert_eq!(truncate_lines_to_byte_limit(text, 13), "Line 1\n");
152 assert_eq!(truncate_lines_to_byte_limit(text, 20), "Line 1\nLine 2\n");
153
154 // Limit before first newline
155 assert_eq!(truncate_lines_to_byte_limit(text, 6), "Line ");
156
157 // Test with non-ASCII characters
158 let text_utf8 = "Line 1\nLΓne 2\nLine 3";
159 assert_eq!(
160 truncate_lines_to_byte_limit(text_utf8, 15),
161 "Line 1\nLΓne 2\n"
162 );
163}
164
165pub fn post_inc<T: From<u8> + AddAssign<T> + Copy>(value: &mut T) -> T {
166 let prev = *value;
167 *value += T::from(1);
168 prev
169}
170
171/// Extend a sorted vector with a sorted sequence of items, maintaining the vector's sort order and
172/// enforcing a maximum length. This also de-duplicates items. Sort the items according to the given callback. Before calling this,
173/// both `vec` and `new_items` should already be sorted according to the `cmp` comparator.
174pub fn extend_sorted<T, I, F>(vec: &mut Vec<T>, new_items: I, limit: usize, mut cmp: F)
175where
176 I: IntoIterator<Item = T>,
177 F: FnMut(&T, &T) -> Ordering,
178{
179 let mut start_index = 0;
180 for new_item in new_items {
181 if let Err(i) = vec[start_index..].binary_search_by(|m| cmp(m, &new_item)) {
182 let index = start_index + i;
183 if vec.len() < limit {
184 vec.insert(index, new_item);
185 } else if index < vec.len() {
186 vec.pop();
187 vec.insert(index, new_item);
188 }
189 start_index = index;
190 }
191 }
192}
193
194pub fn truncate_to_bottom_n_sorted_by<T, F>(items: &mut Vec<T>, limit: usize, compare: &F)
195where
196 F: Fn(&T, &T) -> Ordering,
197{
198 if limit == 0 {
199 items.truncate(0);
200 }
201 if items.len() <= limit {
202 items.sort_by(compare);
203 return;
204 }
205 // When limit is near to items.len() it may be more efficient to sort the whole list and
206 // truncate, rather than always doing selection first as is done below. It's hard to analyze
207 // where the threshold for this should be since the quickselect style algorithm used by
208 // `select_nth_unstable_by` makes the prefix partially sorted, and so its work is not wasted -
209 // the expected number of comparisons needed by `sort_by` is less than it is for some arbitrary
210 // unsorted input.
211 items.select_nth_unstable_by(limit, compare);
212 items.truncate(limit);
213 items.sort_by(compare);
214}
215
216/// Prevents execution of the application with root privileges on Unix systems.
217///
218/// This function checks if the current process is running with root privileges
219/// and terminates the program with an error message unless explicitly allowed via the
220/// `ZED_ALLOW_ROOT` environment variable.
221#[cfg(unix)]
222pub fn prevent_root_execution() {
223 let is_root = nix::unistd::geteuid().is_root();
224 let allow_root = std::env::var("ZED_ALLOW_ROOT").is_ok_and(|val| val == "true");
225
226 if is_root && !allow_root {
227 eprintln!(
228 "\
229Error: Running Zed as root or via sudo is unsupported.
230 Doing so (even once) may subtly break things for all subsequent non-root usage of Zed.
231 It is untested and not recommended, don't complain when things break.
232 If you wish to proceed anyways, set `ZED_ALLOW_ROOT=true` in your environment."
233 );
234 std::process::exit(1);
235 }
236}
237
238#[cfg(unix)]
239fn load_shell_from_passwd() -> Result<()> {
240 let buflen = match unsafe { libc::sysconf(libc::_SC_GETPW_R_SIZE_MAX) } {
241 n if n < 0 => 1024,
242 n => n as usize,
243 };
244 let mut buffer = Vec::with_capacity(buflen);
245
246 let mut pwd: std::mem::MaybeUninit<libc::passwd> = std::mem::MaybeUninit::uninit();
247 let mut result: *mut libc::passwd = std::ptr::null_mut();
248
249 let uid = unsafe { libc::getuid() };
250 let status = unsafe {
251 libc::getpwuid_r(
252 uid,
253 pwd.as_mut_ptr(),
254 buffer.as_mut_ptr() as *mut libc::c_char,
255 buflen,
256 &mut result,
257 )
258 };
259 let entry = unsafe { pwd.assume_init() };
260
261 anyhow::ensure!(
262 status == 0,
263 "call to getpwuid_r failed. uid: {}, status: {}",
264 uid,
265 status
266 );
267 anyhow::ensure!(!result.is_null(), "passwd entry for uid {} not found", uid);
268 anyhow::ensure!(
269 entry.pw_uid == uid,
270 "passwd entry has different uid ({}) than getuid ({}) returned",
271 entry.pw_uid,
272 uid,
273 );
274
275 let shell = unsafe { std::ffi::CStr::from_ptr(entry.pw_shell).to_str().unwrap() };
276 if env::var("SHELL").map_or(true, |shell_env| shell_env != shell) {
277 log::info!(
278 "updating SHELL environment variable to value from passwd entry: {:?}",
279 shell,
280 );
281 unsafe { env::set_var("SHELL", shell) };
282 }
283
284 Ok(())
285}
286
287#[cfg(unix)]
288/// Returns a shell escaped path for the current zed executable
289pub fn get_shell_safe_zed_path() -> anyhow::Result<String> {
290 use anyhow::Context;
291
292 let zed_path = std::env::current_exe()
293 .context("Failed to determine current zed executable path.")?
294 .to_string_lossy()
295 .trim_end_matches(" (deleted)") // see https://github.com/rust-lang/rust/issues/69343
296 .to_string();
297
298 // As of writing, this can only be fail if the path contains a null byte, which shouldn't be possible
299 // but shlex has annotated the error as #[non_exhaustive] so we can't make it a compile error if other
300 // errors are introduced in the future :(
301 let zed_path_escaped =
302 shlex::try_quote(&zed_path).context("Failed to shell-escape Zed executable path.")?;
303
304 Ok(zed_path_escaped.to_string())
305}
306
307#[cfg(unix)]
308pub fn load_login_shell_environment() -> Result<()> {
309 load_shell_from_passwd().log_err();
310
311 // If possible, we want to `cd` in the user's `$HOME` to trigger programs
312 // such as direnv, asdf, mise, ... to adjust the PATH. These tools often hook
313 // into shell's `cd` command (and hooks) to manipulate env.
314 // We do this so that we get the env a user would have when spawning a shell
315 // in home directory.
316 for (name, value) in shell_env::capture(paths::home_dir())? {
317 unsafe { env::set_var(&name, &value) };
318 }
319
320 log::info!(
321 "set environment variables from shell:{}, path:{}",
322 std::env::var("SHELL").unwrap_or_default(),
323 std::env::var("PATH").unwrap_or_default(),
324 );
325
326 Ok(())
327}
328
329/// Configures the process to start a new session, to prevent interactive shells from taking control
330/// of the terminal.
331///
332/// For more details: <https://registerspill.thorstenball.com/p/how-to-lose-control-of-your-shell>
333pub fn set_pre_exec_to_start_new_session(
334 command: &mut std::process::Command,
335) -> &mut std::process::Command {
336 // safety: code in pre_exec should be signal safe.
337 // https://man7.org/linux/man-pages/man7/signal-safety.7.html
338 #[cfg(not(target_os = "windows"))]
339 unsafe {
340 use std::os::unix::process::CommandExt;
341 command.pre_exec(|| {
342 libc::setsid();
343 Ok(())
344 });
345 };
346 command
347}
348
349pub fn merge_json_lenient_value_into(
350 source: serde_json_lenient::Value,
351 target: &mut serde_json_lenient::Value,
352) {
353 match (source, target) {
354 (serde_json_lenient::Value::Object(source), serde_json_lenient::Value::Object(target)) => {
355 for (key, value) in source {
356 if let Some(target) = target.get_mut(&key) {
357 merge_json_lenient_value_into(value, target);
358 } else {
359 target.insert(key, value);
360 }
361 }
362 }
363
364 (serde_json_lenient::Value::Array(source), serde_json_lenient::Value::Array(target)) => {
365 for value in source {
366 target.push(value);
367 }
368 }
369
370 (source, target) => *target = source,
371 }
372}
373
374pub fn merge_json_value_into(source: serde_json::Value, target: &mut serde_json::Value) {
375 use serde_json::Value;
376
377 match (source, target) {
378 (Value::Object(source), Value::Object(target)) => {
379 for (key, value) in source {
380 if let Some(target) = target.get_mut(&key) {
381 merge_json_value_into(value, target);
382 } else {
383 target.insert(key, value);
384 }
385 }
386 }
387
388 (Value::Array(source), Value::Array(target)) => {
389 for value in source {
390 target.push(value);
391 }
392 }
393
394 (source, target) => *target = source,
395 }
396}
397
398pub fn merge_non_null_json_value_into(source: serde_json::Value, target: &mut serde_json::Value) {
399 use serde_json::Value;
400 if let Value::Object(source_object) = source {
401 let target_object = if let Value::Object(target) = target {
402 target
403 } else {
404 *target = Value::Object(Default::default());
405 target.as_object_mut().unwrap()
406 };
407 for (key, value) in source_object {
408 if let Some(target) = target_object.get_mut(&key) {
409 merge_non_null_json_value_into(value, target);
410 } else if !value.is_null() {
411 target_object.insert(key, value);
412 }
413 }
414 } else if !source.is_null() {
415 *target = source
416 }
417}
418
419pub fn measure<R>(label: &str, f: impl FnOnce() -> R) -> R {
420 static ZED_MEASUREMENTS: OnceLock<bool> = OnceLock::new();
421 let zed_measurements = ZED_MEASUREMENTS.get_or_init(|| {
422 env::var("ZED_MEASUREMENTS")
423 .map(|measurements| measurements == "1" || measurements == "true")
424 .unwrap_or(false)
425 });
426
427 if *zed_measurements {
428 let start = Instant::now();
429 let result = f();
430 let elapsed = start.elapsed();
431 eprintln!("{}: {:?}", label, elapsed);
432 result
433 } else {
434 f()
435 }
436}
437
438pub fn expanded_and_wrapped_usize_range(
439 range: Range<usize>,
440 additional_before: usize,
441 additional_after: usize,
442 wrap_length: usize,
443) -> impl Iterator<Item = usize> {
444 let start_wraps = range.start < additional_before;
445 let end_wraps = wrap_length < range.end + additional_after;
446 if start_wraps && end_wraps {
447 Either::Left(0..wrap_length)
448 } else if start_wraps {
449 let wrapped_start = (range.start + wrap_length).saturating_sub(additional_before);
450 if wrapped_start <= range.end {
451 Either::Left(0..wrap_length)
452 } else {
453 Either::Right((0..range.end + additional_after).chain(wrapped_start..wrap_length))
454 }
455 } else if end_wraps {
456 let wrapped_end = range.end + additional_after - wrap_length;
457 if range.start <= wrapped_end {
458 Either::Left(0..wrap_length)
459 } else {
460 Either::Right((0..wrapped_end).chain(range.start - additional_before..wrap_length))
461 }
462 } else {
463 Either::Left((range.start - additional_before)..(range.end + additional_after))
464 }
465}
466
467/// Yields `[i, i + 1, i - 1, i + 2, ..]`, each modulo `wrap_length` and bounded by
468/// `additional_before` and `additional_after`. If the wrapping causes overlap, duplicates are not
469/// emitted. If wrap_length is 0, nothing is yielded.
470pub fn wrapped_usize_outward_from(
471 start: usize,
472 additional_before: usize,
473 additional_after: usize,
474 wrap_length: usize,
475) -> impl Iterator<Item = usize> {
476 let mut count = 0;
477 let mut after_offset = 1;
478 let mut before_offset = 1;
479
480 std::iter::from_fn(move || {
481 count += 1;
482 if count > wrap_length {
483 None
484 } else if count == 1 {
485 Some(start % wrap_length)
486 } else if after_offset <= additional_after && after_offset <= before_offset {
487 let value = (start + after_offset) % wrap_length;
488 after_offset += 1;
489 Some(value)
490 } else if before_offset <= additional_before {
491 let value = (start + wrap_length - before_offset) % wrap_length;
492 before_offset += 1;
493 Some(value)
494 } else if after_offset <= additional_after {
495 let value = (start + after_offset) % wrap_length;
496 after_offset += 1;
497 Some(value)
498 } else {
499 None
500 }
501 })
502}
503
504#[cfg(target_os = "windows")]
505pub fn get_windows_system_shell() -> String {
506 use std::path::PathBuf;
507
508 fn find_pwsh_in_programfiles(find_alternate: bool, find_preview: bool) -> Option<PathBuf> {
509 #[cfg(target_pointer_width = "64")]
510 let env_var = if find_alternate {
511 "ProgramFiles(x86)"
512 } else {
513 "ProgramFiles"
514 };
515
516 #[cfg(target_pointer_width = "32")]
517 let env_var = if find_alternate {
518 "ProgramW6432"
519 } else {
520 "ProgramFiles"
521 };
522
523 let install_base_dir = PathBuf::from(std::env::var_os(env_var)?).join("PowerShell");
524 install_base_dir
525 .read_dir()
526 .ok()?
527 .filter_map(Result::ok)
528 .filter(|entry| matches!(entry.file_type(), Ok(ft) if ft.is_dir()))
529 .filter_map(|entry| {
530 let dir_name = entry.file_name();
531 let dir_name = dir_name.to_string_lossy();
532
533 let version = if find_preview {
534 let dash_index = dir_name.find('-')?;
535 if &dir_name[dash_index + 1..] != "preview" {
536 return None;
537 };
538 dir_name[..dash_index].parse::<u32>().ok()?
539 } else {
540 dir_name.parse::<u32>().ok()?
541 };
542
543 let exe_path = entry.path().join("pwsh.exe");
544 if exe_path.exists() {
545 Some((version, exe_path))
546 } else {
547 None
548 }
549 })
550 .max_by_key(|(version, _)| *version)
551 .map(|(_, path)| path)
552 }
553
554 fn find_pwsh_in_msix(find_preview: bool) -> Option<PathBuf> {
555 let msix_app_dir =
556 PathBuf::from(std::env::var_os("LOCALAPPDATA")?).join("Microsoft\\WindowsApps");
557 if !msix_app_dir.exists() {
558 return None;
559 }
560
561 let prefix = if find_preview {
562 "Microsoft.PowerShellPreview_"
563 } else {
564 "Microsoft.PowerShell_"
565 };
566 msix_app_dir
567 .read_dir()
568 .ok()?
569 .filter_map(|entry| {
570 let entry = entry.ok()?;
571 if !matches!(entry.file_type(), Ok(ft) if ft.is_dir()) {
572 return None;
573 }
574
575 if !entry.file_name().to_string_lossy().starts_with(prefix) {
576 return None;
577 }
578
579 let exe_path = entry.path().join("pwsh.exe");
580 exe_path.exists().then_some(exe_path)
581 })
582 .next()
583 }
584
585 fn find_pwsh_in_scoop() -> Option<PathBuf> {
586 let pwsh_exe =
587 PathBuf::from(std::env::var_os("USERPROFILE")?).join("scoop\\shims\\pwsh.exe");
588 pwsh_exe.exists().then_some(pwsh_exe)
589 }
590
591 static SYSTEM_SHELL: LazyLock<String> = LazyLock::new(|| {
592 find_pwsh_in_programfiles(false, false)
593 .or_else(|| find_pwsh_in_programfiles(true, false))
594 .or_else(|| find_pwsh_in_msix(false))
595 .or_else(|| find_pwsh_in_programfiles(false, true))
596 .or_else(|| find_pwsh_in_msix(true))
597 .or_else(|| find_pwsh_in_programfiles(true, true))
598 .or_else(find_pwsh_in_scoop)
599 .map(|p| p.to_string_lossy().to_string())
600 .unwrap_or("powershell.exe".to_string())
601 });
602
603 (*SYSTEM_SHELL).clone()
604}
605
606pub trait ResultExt<E> {
607 type Ok;
608
609 fn log_err(self) -> Option<Self::Ok>;
610 /// Assert that this result should never be an error in development or tests.
611 fn debug_assert_ok(self, reason: &str) -> Self;
612 fn warn_on_err(self) -> Option<Self::Ok>;
613 fn log_with_level(self, level: log::Level) -> Option<Self::Ok>;
614 fn anyhow(self) -> anyhow::Result<Self::Ok>
615 where
616 E: Into<anyhow::Error>;
617}
618
619impl<T, E> ResultExt<E> for Result<T, E>
620where
621 E: std::fmt::Debug,
622{
623 type Ok = T;
624
625 #[track_caller]
626 fn log_err(self) -> Option<T> {
627 self.log_with_level(log::Level::Error)
628 }
629
630 #[track_caller]
631 fn debug_assert_ok(self, reason: &str) -> Self {
632 if let Err(error) = &self {
633 debug_panic!("{reason} - {error:?}");
634 }
635 self
636 }
637
638 #[track_caller]
639 fn warn_on_err(self) -> Option<T> {
640 self.log_with_level(log::Level::Warn)
641 }
642
643 #[track_caller]
644 fn log_with_level(self, level: log::Level) -> Option<T> {
645 match self {
646 Ok(value) => Some(value),
647 Err(error) => {
648 log_error_with_caller(*Location::caller(), error, level);
649 None
650 }
651 }
652 }
653
654 fn anyhow(self) -> anyhow::Result<T>
655 where
656 E: Into<anyhow::Error>,
657 {
658 self.map_err(Into::into)
659 }
660}
661
662fn log_error_with_caller<E>(caller: core::panic::Location<'_>, error: E, level: log::Level)
663where
664 E: std::fmt::Debug,
665{
666 #[cfg(not(target_os = "windows"))]
667 let file = caller.file();
668 #[cfg(target_os = "windows")]
669 let file = caller.file().replace('\\', "/");
670 // In this codebase all crates reside in a `crates` directory,
671 // so discard the prefix up to that segment to find the crate name
672 let target = file
673 .split_once("crates/")
674 .and_then(|(_, s)| s.split_once('/'))
675 .map(|(p, _)| p);
676
677 log::logger().log(
678 &log::Record::builder()
679 .target(target.unwrap_or(""))
680 .module_path(target)
681 .args(format_args!("{:?}", error))
682 .file(Some(caller.file()))
683 .line(Some(caller.line()))
684 .level(level)
685 .build(),
686 );
687}
688
689pub fn log_err<E: std::fmt::Debug>(error: &E) {
690 log_error_with_caller(*Location::caller(), error, log::Level::Warn);
691}
692
693pub trait TryFutureExt {
694 fn log_err(self) -> LogErrorFuture<Self>
695 where
696 Self: Sized;
697
698 fn log_tracked_err(self, location: core::panic::Location<'static>) -> LogErrorFuture<Self>
699 where
700 Self: Sized;
701
702 fn warn_on_err(self) -> LogErrorFuture<Self>
703 where
704 Self: Sized;
705 fn unwrap(self) -> UnwrapFuture<Self>
706 where
707 Self: Sized;
708}
709
710impl<F, T, E> TryFutureExt for F
711where
712 F: Future<Output = Result<T, E>>,
713 E: std::fmt::Debug,
714{
715 #[track_caller]
716 fn log_err(self) -> LogErrorFuture<Self>
717 where
718 Self: Sized,
719 {
720 let location = Location::caller();
721 LogErrorFuture(self, log::Level::Error, *location)
722 }
723
724 fn log_tracked_err(self, location: core::panic::Location<'static>) -> LogErrorFuture<Self>
725 where
726 Self: Sized,
727 {
728 LogErrorFuture(self, log::Level::Error, location)
729 }
730
731 #[track_caller]
732 fn warn_on_err(self) -> LogErrorFuture<Self>
733 where
734 Self: Sized,
735 {
736 let location = Location::caller();
737 LogErrorFuture(self, log::Level::Warn, *location)
738 }
739
740 fn unwrap(self) -> UnwrapFuture<Self>
741 where
742 Self: Sized,
743 {
744 UnwrapFuture(self)
745 }
746}
747
748#[must_use]
749pub struct LogErrorFuture<F>(F, log::Level, core::panic::Location<'static>);
750
751impl<F, T, E> Future for LogErrorFuture<F>
752where
753 F: Future<Output = Result<T, E>>,
754 E: std::fmt::Debug,
755{
756 type Output = Option<T>;
757
758 fn poll(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Self::Output> {
759 let level = self.1;
760 let location = self.2;
761 let inner = unsafe { Pin::new_unchecked(&mut self.get_unchecked_mut().0) };
762 match inner.poll(cx) {
763 Poll::Ready(output) => Poll::Ready(match output {
764 Ok(output) => Some(output),
765 Err(error) => {
766 log_error_with_caller(location, error, level);
767 None
768 }
769 }),
770 Poll::Pending => Poll::Pending,
771 }
772 }
773}
774
775pub struct UnwrapFuture<F>(F);
776
777impl<F, T, E> Future for UnwrapFuture<F>
778where
779 F: Future<Output = Result<T, E>>,
780 E: std::fmt::Debug,
781{
782 type Output = T;
783
784 fn poll(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Self::Output> {
785 let inner = unsafe { Pin::new_unchecked(&mut self.get_unchecked_mut().0) };
786 match inner.poll(cx) {
787 Poll::Ready(result) => Poll::Ready(result.unwrap()),
788 Poll::Pending => Poll::Pending,
789 }
790 }
791}
792
793pub struct Deferred<F: FnOnce()>(Option<F>);
794
795impl<F: FnOnce()> Deferred<F> {
796 /// Drop without running the deferred function.
797 pub fn abort(mut self) {
798 self.0.take();
799 }
800}
801
802impl<F: FnOnce()> Drop for Deferred<F> {
803 fn drop(&mut self) {
804 if let Some(f) = self.0.take() {
805 f()
806 }
807 }
808}
809
810/// Run the given function when the returned value is dropped (unless it's cancelled).
811#[must_use]
812pub fn defer<F: FnOnce()>(f: F) -> Deferred<F> {
813 Deferred(Some(f))
814}
815
816#[cfg(any(test, feature = "test-support"))]
817mod rng {
818 use rand::prelude::*;
819
820 pub struct RandomCharIter<T: Rng> {
821 rng: T,
822 simple_text: bool,
823 }
824
825 impl<T: Rng> RandomCharIter<T> {
826 pub fn new(rng: T) -> Self {
827 Self {
828 rng,
829 simple_text: std::env::var("SIMPLE_TEXT").is_ok_and(|v| !v.is_empty()),
830 }
831 }
832
833 pub fn with_simple_text(mut self) -> Self {
834 self.simple_text = true;
835 self
836 }
837 }
838
839 impl<T: Rng> Iterator for RandomCharIter<T> {
840 type Item = char;
841
842 fn next(&mut self) -> Option<Self::Item> {
843 if self.simple_text {
844 return if self.rng.random_range(0..100) < 5 {
845 Some('\n')
846 } else {
847 Some(self.rng.random_range(b'a'..b'z' + 1).into())
848 };
849 }
850
851 match self.rng.random_range(0..100) {
852 // whitespace
853 0..=19 => [' ', '\n', '\r', '\t'].choose(&mut self.rng).copied(),
854 // two-byte greek letters
855 20..=32 => char::from_u32(self.rng.random_range(('Ξ±' as u32)..('Ο' as u32 + 1))),
856 // // three-byte characters
857 33..=45 => ['β', 'β
', 'β', 'β', 'β']
858 .choose(&mut self.rng)
859 .copied(),
860 // // four-byte characters
861 46..=58 => ['π', 'π', 'π', 'π'].choose(&mut self.rng).copied(),
862 // ascii letters
863 _ => Some(self.rng.random_range(b'a'..b'z' + 1).into()),
864 }
865 }
866 }
867}
868#[cfg(any(test, feature = "test-support"))]
869pub use rng::RandomCharIter;
870
871/// Get an embedded file as a string.
872pub fn asset_str<A: rust_embed::RustEmbed>(path: &str) -> Cow<'static, str> {
873 match A::get(path).expect(path).data {
874 Cow::Borrowed(bytes) => Cow::Borrowed(std::str::from_utf8(bytes).unwrap()),
875 Cow::Owned(bytes) => Cow::Owned(String::from_utf8(bytes).unwrap()),
876 }
877}
878
879/// Expands to an immediately-invoked function expression. Good for using the ? operator
880/// in functions which do not return an Option or Result.
881///
882/// Accepts a normal block, an async block, or an async move block.
883#[macro_export]
884macro_rules! maybe {
885 ($block:block) => {
886 (|| $block)()
887 };
888 (async $block:block) => {
889 (async || $block)()
890 };
891 (async move $block:block) => {
892 (async move || $block)()
893 };
894}
895
896pub trait RangeExt<T> {
897 fn sorted(&self) -> Self;
898 fn to_inclusive(&self) -> RangeInclusive<T>;
899 fn overlaps(&self, other: &Range<T>) -> bool;
900 fn contains_inclusive(&self, other: &Range<T>) -> bool;
901}
902
903impl<T: Ord + Clone> RangeExt<T> for Range<T> {
904 fn sorted(&self) -> Self {
905 cmp::min(&self.start, &self.end).clone()..cmp::max(&self.start, &self.end).clone()
906 }
907
908 fn to_inclusive(&self) -> RangeInclusive<T> {
909 self.start.clone()..=self.end.clone()
910 }
911
912 fn overlaps(&self, other: &Range<T>) -> bool {
913 self.start < other.end && other.start < self.end
914 }
915
916 fn contains_inclusive(&self, other: &Range<T>) -> bool {
917 self.start <= other.start && other.end <= self.end
918 }
919}
920
921impl<T: Ord + Clone> RangeExt<T> for RangeInclusive<T> {
922 fn sorted(&self) -> Self {
923 cmp::min(self.start(), self.end()).clone()..=cmp::max(self.start(), self.end()).clone()
924 }
925
926 fn to_inclusive(&self) -> RangeInclusive<T> {
927 self.clone()
928 }
929
930 fn overlaps(&self, other: &Range<T>) -> bool {
931 self.start() < &other.end && &other.start <= self.end()
932 }
933
934 fn contains_inclusive(&self, other: &Range<T>) -> bool {
935 self.start() <= &other.start && &other.end <= self.end()
936 }
937}
938
939/// A way to sort strings with starting numbers numerically first, falling back to alphanumeric one,
940/// case-insensitive.
941///
942/// This is useful for turning regular alphanumerically sorted sequences as `1-abc, 10, 11-def, .., 2, 21-abc`
943/// into `1-abc, 2, 10, 11-def, .., 21-abc`
944#[derive(Debug, PartialEq, Eq)]
945pub struct NumericPrefixWithSuffix<'a>(Option<u64>, &'a str);
946
947impl<'a> NumericPrefixWithSuffix<'a> {
948 pub fn from_numeric_prefixed_str(str: &'a str) -> Self {
949 let i = str.chars().take_while(|c| c.is_ascii_digit()).count();
950 let (prefix, remainder) = str.split_at(i);
951
952 let prefix = prefix.parse().ok();
953 Self(prefix, remainder)
954 }
955}
956
957/// When dealing with equality, we need to consider the case of the strings to achieve strict equality
958/// to handle cases like "a" < "A" instead of "a" == "A".
959impl Ord for NumericPrefixWithSuffix<'_> {
960 fn cmp(&self, other: &Self) -> Ordering {
961 match (self.0, other.0) {
962 (None, None) => UniCase::new(self.1)
963 .cmp(&UniCase::new(other.1))
964 .then_with(|| self.1.cmp(other.1).reverse()),
965 (None, Some(_)) => Ordering::Greater,
966 (Some(_), None) => Ordering::Less,
967 (Some(a), Some(b)) => a.cmp(&b).then_with(|| {
968 UniCase::new(self.1)
969 .cmp(&UniCase::new(other.1))
970 .then_with(|| self.1.cmp(other.1).reverse())
971 }),
972 }
973 }
974}
975
976impl PartialOrd for NumericPrefixWithSuffix<'_> {
977 fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
978 Some(self.cmp(other))
979 }
980}
981
982/// Capitalizes the first character of a string.
983///
984/// This function takes a string slice as input and returns a new `String` with the first character
985/// capitalized.
986///
987/// # Examples
988///
989/// ```
990/// use util::capitalize;
991///
992/// assert_eq!(capitalize("hello"), "Hello");
993/// assert_eq!(capitalize("WORLD"), "WORLD");
994/// assert_eq!(capitalize(""), "");
995/// ```
996pub fn capitalize(str: &str) -> String {
997 let mut chars = str.chars();
998 match chars.next() {
999 None => String::new(),
1000 Some(first_char) => first_char.to_uppercase().collect::<String>() + chars.as_str(),
1001 }
1002}
1003
1004fn emoji_regex() -> &'static Regex {
1005 static EMOJI_REGEX: LazyLock<Regex> =
1006 LazyLock::new(|| Regex::new("(\\p{Emoji}|\u{200D})").unwrap());
1007 &EMOJI_REGEX
1008}
1009
1010/// Returns true if the given string consists of emojis only.
1011/// E.g. "π¨βπ©βπ§βπ§π" will return true, but "π!" will return false.
1012pub fn word_consists_of_emojis(s: &str) -> bool {
1013 let mut prev_end = 0;
1014 for capture in emoji_regex().find_iter(s) {
1015 if capture.start() != prev_end {
1016 return false;
1017 }
1018 prev_end = capture.end();
1019 }
1020 prev_end == s.len()
1021}
1022
1023/// Similar to `str::split`, but also provides byte-offset ranges of the results. Unlike
1024/// `str::split`, this is not generic on pattern types and does not return an `Iterator`.
1025pub fn split_str_with_ranges(s: &str, pat: impl Fn(char) -> bool) -> Vec<(Range<usize>, &str)> {
1026 let mut result = Vec::new();
1027 let mut start = 0;
1028
1029 for (i, ch) in s.char_indices() {
1030 if pat(ch) {
1031 if i > start {
1032 result.push((start..i, &s[start..i]));
1033 }
1034 start = i + ch.len_utf8();
1035 }
1036 }
1037
1038 if s.len() > start {
1039 result.push((start..s.len(), &s[start..s.len()]));
1040 }
1041
1042 result
1043}
1044
1045pub fn default<D: Default>() -> D {
1046 Default::default()
1047}
1048
1049pub fn get_system_shell() -> String {
1050 #[cfg(target_os = "windows")]
1051 {
1052 get_windows_system_shell()
1053 }
1054
1055 #[cfg(not(target_os = "windows"))]
1056 {
1057 std::env::var("SHELL").unwrap_or("/bin/sh".to_string())
1058 }
1059}
1060
1061pub fn get_default_system_shell() -> String {
1062 #[cfg(target_os = "windows")]
1063 {
1064 get_windows_system_shell()
1065 }
1066
1067 #[cfg(not(target_os = "windows"))]
1068 {
1069 "/bin/sh".to_string()
1070 }
1071}
1072
1073#[derive(Debug)]
1074pub enum ConnectionResult<O> {
1075 Timeout,
1076 ConnectionReset,
1077 Result(anyhow::Result<O>),
1078}
1079
1080impl<O> ConnectionResult<O> {
1081 pub fn into_response(self) -> anyhow::Result<O> {
1082 match self {
1083 ConnectionResult::Timeout => anyhow::bail!("Request timed out"),
1084 ConnectionResult::ConnectionReset => anyhow::bail!("Server reset the connection"),
1085 ConnectionResult::Result(r) => r,
1086 }
1087 }
1088}
1089
1090impl<O> From<anyhow::Result<O>> for ConnectionResult<O> {
1091 fn from(result: anyhow::Result<O>) -> Self {
1092 ConnectionResult::Result(result)
1093 }
1094}
1095
1096#[cfg(test)]
1097mod tests {
1098 use super::*;
1099
1100 #[test]
1101 fn test_extend_sorted() {
1102 let mut vec = vec![];
1103
1104 extend_sorted(&mut vec, vec![21, 17, 13, 8, 1, 0], 5, |a, b| b.cmp(a));
1105 assert_eq!(vec, &[21, 17, 13, 8, 1]);
1106
1107 extend_sorted(&mut vec, vec![101, 19, 17, 8, 2], 8, |a, b| b.cmp(a));
1108 assert_eq!(vec, &[101, 21, 19, 17, 13, 8, 2, 1]);
1109
1110 extend_sorted(&mut vec, vec![1000, 19, 17, 9, 5], 8, |a, b| b.cmp(a));
1111 assert_eq!(vec, &[1000, 101, 21, 19, 17, 13, 9, 8]);
1112 }
1113
1114 #[test]
1115 fn test_truncate_to_bottom_n_sorted_by() {
1116 let mut vec: Vec<u32> = vec![5, 2, 3, 4, 1];
1117 truncate_to_bottom_n_sorted_by(&mut vec, 10, &u32::cmp);
1118 assert_eq!(vec, &[1, 2, 3, 4, 5]);
1119
1120 vec = vec![5, 2, 3, 4, 1];
1121 truncate_to_bottom_n_sorted_by(&mut vec, 5, &u32::cmp);
1122 assert_eq!(vec, &[1, 2, 3, 4, 5]);
1123
1124 vec = vec![5, 2, 3, 4, 1];
1125 truncate_to_bottom_n_sorted_by(&mut vec, 4, &u32::cmp);
1126 assert_eq!(vec, &[1, 2, 3, 4]);
1127
1128 vec = vec![5, 2, 3, 4, 1];
1129 truncate_to_bottom_n_sorted_by(&mut vec, 1, &u32::cmp);
1130 assert_eq!(vec, &[1]);
1131
1132 vec = vec![5, 2, 3, 4, 1];
1133 truncate_to_bottom_n_sorted_by(&mut vec, 0, &u32::cmp);
1134 assert!(vec.is_empty());
1135 }
1136
1137 #[test]
1138 fn test_iife() {
1139 fn option_returning_function() -> Option<()> {
1140 None
1141 }
1142
1143 let foo = maybe!({
1144 option_returning_function()?;
1145 Some(())
1146 });
1147
1148 assert_eq!(foo, None);
1149 }
1150
1151 #[test]
1152 fn test_truncate_and_trailoff() {
1153 assert_eq!(truncate_and_trailoff("", 5), "");
1154 assert_eq!(truncate_and_trailoff("aaaaaa", 7), "aaaaaa");
1155 assert_eq!(truncate_and_trailoff("aaaaaa", 6), "aaaaaa");
1156 assert_eq!(truncate_and_trailoff("aaaaaa", 5), "aaaaaβ¦");
1157 assert_eq!(truncate_and_trailoff("èèèèèè", 7), "èèèèèè");
1158 assert_eq!(truncate_and_trailoff("èèèèèè", 6), "èèèèèè");
1159 assert_eq!(truncate_and_trailoff("èèèèèè", 5), "èèèèèβ¦");
1160 }
1161
1162 #[test]
1163 fn test_truncate_and_remove_front() {
1164 assert_eq!(truncate_and_remove_front("", 5), "");
1165 assert_eq!(truncate_and_remove_front("aaaaaa", 7), "aaaaaa");
1166 assert_eq!(truncate_and_remove_front("aaaaaa", 6), "aaaaaa");
1167 assert_eq!(truncate_and_remove_front("aaaaaa", 5), "β¦aaaaa");
1168 assert_eq!(truncate_and_remove_front("èèèèèè", 7), "èèèèèè");
1169 assert_eq!(truncate_and_remove_front("èèèèèè", 6), "èèèèèè");
1170 assert_eq!(truncate_and_remove_front("èèèèèè", 5), "β¦Γ¨Γ¨Γ¨Γ¨Γ¨");
1171 }
1172
1173 #[test]
1174 fn test_numeric_prefix_str_method() {
1175 let target = "1a";
1176 assert_eq!(
1177 NumericPrefixWithSuffix::from_numeric_prefixed_str(target),
1178 NumericPrefixWithSuffix(Some(1), "a")
1179 );
1180
1181 let target = "12ab";
1182 assert_eq!(
1183 NumericPrefixWithSuffix::from_numeric_prefixed_str(target),
1184 NumericPrefixWithSuffix(Some(12), "ab")
1185 );
1186
1187 let target = "12_ab";
1188 assert_eq!(
1189 NumericPrefixWithSuffix::from_numeric_prefixed_str(target),
1190 NumericPrefixWithSuffix(Some(12), "_ab")
1191 );
1192
1193 let target = "1_2ab";
1194 assert_eq!(
1195 NumericPrefixWithSuffix::from_numeric_prefixed_str(target),
1196 NumericPrefixWithSuffix(Some(1), "_2ab")
1197 );
1198
1199 let target = "1.2";
1200 assert_eq!(
1201 NumericPrefixWithSuffix::from_numeric_prefixed_str(target),
1202 NumericPrefixWithSuffix(Some(1), ".2")
1203 );
1204
1205 let target = "1.2_a";
1206 assert_eq!(
1207 NumericPrefixWithSuffix::from_numeric_prefixed_str(target),
1208 NumericPrefixWithSuffix(Some(1), ".2_a")
1209 );
1210
1211 let target = "12.2_a";
1212 assert_eq!(
1213 NumericPrefixWithSuffix::from_numeric_prefixed_str(target),
1214 NumericPrefixWithSuffix(Some(12), ".2_a")
1215 );
1216
1217 let target = "12a.2_a";
1218 assert_eq!(
1219 NumericPrefixWithSuffix::from_numeric_prefixed_str(target),
1220 NumericPrefixWithSuffix(Some(12), "a.2_a")
1221 );
1222 }
1223
1224 #[test]
1225 fn test_numeric_prefix_with_suffix() {
1226 let mut sorted = vec!["1-abc", "10", "11def", "2", "21-abc"];
1227 sorted.sort_by_key(|s| NumericPrefixWithSuffix::from_numeric_prefixed_str(s));
1228 assert_eq!(sorted, ["1-abc", "2", "10", "11def", "21-abc"]);
1229
1230 for numeric_prefix_less in ["numeric_prefix_less", "aaa", "~β’Β£"] {
1231 assert_eq!(
1232 NumericPrefixWithSuffix::from_numeric_prefixed_str(numeric_prefix_less),
1233 NumericPrefixWithSuffix(None, numeric_prefix_less),
1234 "String without numeric prefix `{numeric_prefix_less}` should not be converted into NumericPrefixWithSuffix"
1235 )
1236 }
1237 }
1238
1239 #[test]
1240 fn test_word_consists_of_emojis() {
1241 let words_to_test = vec![
1242 ("π¨βπ©βπ§βπ§ππ₯", true),
1243 ("π", true),
1244 ("!π", false),
1245 ("π!", false),
1246 ("π ", false),
1247 (" π", false),
1248 ("Test", false),
1249 ];
1250
1251 for (text, expected_result) in words_to_test {
1252 assert_eq!(word_consists_of_emojis(text), expected_result);
1253 }
1254 }
1255
1256 #[test]
1257 fn test_truncate_lines_and_trailoff() {
1258 let text = r#"Line 1
1259Line 2
1260Line 3"#;
1261
1262 assert_eq!(
1263 truncate_lines_and_trailoff(text, 2),
1264 r#"Line 1
1265β¦"#
1266 );
1267
1268 assert_eq!(
1269 truncate_lines_and_trailoff(text, 3),
1270 r#"Line 1
1271Line 2
1272β¦"#
1273 );
1274
1275 assert_eq!(
1276 truncate_lines_and_trailoff(text, 4),
1277 r#"Line 1
1278Line 2
1279Line 3"#
1280 );
1281 }
1282
1283 #[test]
1284 fn test_expanded_and_wrapped_usize_range() {
1285 // Neither wrap
1286 assert_eq!(
1287 expanded_and_wrapped_usize_range(2..4, 1, 1, 8).collect::<Vec<usize>>(),
1288 (1..5).collect::<Vec<usize>>()
1289 );
1290 // Start wraps
1291 assert_eq!(
1292 expanded_and_wrapped_usize_range(2..4, 3, 1, 8).collect::<Vec<usize>>(),
1293 ((0..5).chain(7..8)).collect::<Vec<usize>>()
1294 );
1295 // Start wraps all the way around
1296 assert_eq!(
1297 expanded_and_wrapped_usize_range(2..4, 5, 1, 8).collect::<Vec<usize>>(),
1298 (0..8).collect::<Vec<usize>>()
1299 );
1300 // Start wraps all the way around and past 0
1301 assert_eq!(
1302 expanded_and_wrapped_usize_range(2..4, 10, 1, 8).collect::<Vec<usize>>(),
1303 (0..8).collect::<Vec<usize>>()
1304 );
1305 // End wraps
1306 assert_eq!(
1307 expanded_and_wrapped_usize_range(3..5, 1, 4, 8).collect::<Vec<usize>>(),
1308 (0..1).chain(2..8).collect::<Vec<usize>>()
1309 );
1310 // End wraps all the way around
1311 assert_eq!(
1312 expanded_and_wrapped_usize_range(3..5, 1, 5, 8).collect::<Vec<usize>>(),
1313 (0..8).collect::<Vec<usize>>()
1314 );
1315 // End wraps all the way around and past the end
1316 assert_eq!(
1317 expanded_and_wrapped_usize_range(3..5, 1, 10, 8).collect::<Vec<usize>>(),
1318 (0..8).collect::<Vec<usize>>()
1319 );
1320 // Both start and end wrap
1321 assert_eq!(
1322 expanded_and_wrapped_usize_range(3..5, 4, 4, 8).collect::<Vec<usize>>(),
1323 (0..8).collect::<Vec<usize>>()
1324 );
1325 }
1326
1327 #[test]
1328 fn test_wrapped_usize_outward_from() {
1329 // No wrapping
1330 assert_eq!(
1331 wrapped_usize_outward_from(4, 2, 2, 10).collect::<Vec<usize>>(),
1332 vec![4, 5, 3, 6, 2]
1333 );
1334 // Wrapping at end
1335 assert_eq!(
1336 wrapped_usize_outward_from(8, 2, 3, 10).collect::<Vec<usize>>(),
1337 vec![8, 9, 7, 0, 6, 1]
1338 );
1339 // Wrapping at start
1340 assert_eq!(
1341 wrapped_usize_outward_from(1, 3, 2, 10).collect::<Vec<usize>>(),
1342 vec![1, 2, 0, 3, 9, 8]
1343 );
1344 // All values wrap around
1345 assert_eq!(
1346 wrapped_usize_outward_from(5, 10, 10, 8).collect::<Vec<usize>>(),
1347 vec![5, 6, 4, 7, 3, 0, 2, 1]
1348 );
1349 // None before / after
1350 assert_eq!(
1351 wrapped_usize_outward_from(3, 0, 0, 8).collect::<Vec<usize>>(),
1352 vec![3]
1353 );
1354 // Starting point already wrapped
1355 assert_eq!(
1356 wrapped_usize_outward_from(15, 2, 2, 10).collect::<Vec<usize>>(),
1357 vec![5, 6, 4, 7, 3]
1358 );
1359 // wrap_length of 0
1360 assert_eq!(
1361 wrapped_usize_outward_from(4, 2, 2, 0).collect::<Vec<usize>>(),
1362 Vec::<usize>::new()
1363 );
1364 }
1365
1366 #[test]
1367 fn test_split_with_ranges() {
1368 let input = "hi";
1369 let result = split_str_with_ranges(input, |c| c == ' ');
1370
1371 assert_eq!(result.len(), 1);
1372 assert_eq!(result[0], (0..2, "hi"));
1373
1374 let input = "hΓ©lloπ¦world";
1375 let result = split_str_with_ranges(input, |c| c == 'π¦');
1376
1377 assert_eq!(result.len(), 2);
1378 assert_eq!(result[0], (0..6, "hΓ©llo")); // 'Γ©' is 2 bytes
1379 assert_eq!(result[1], (10..15, "world")); // 'π¦' is 4 bytes
1380 }
1381}