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)
132 && s.as_bytes()[i] == b'\n' {
133 // Since the i-th character is \n, valid to slice at i + 1.
134 return &s[..i + 1];
135 }
136 }
137
138 truncate_to_byte_limit(s, max_bytes)
139}
140
141#[test]
142fn test_truncate_lines_to_byte_limit() {
143 let text = "Line 1\nLine 2\nLine 3\nLine 4";
144
145 // Limit that includes all lines
146 assert_eq!(truncate_lines_to_byte_limit(text, 100), text);
147
148 // Exactly the first line
149 assert_eq!(truncate_lines_to_byte_limit(text, 7), "Line 1\n");
150
151 // Limit between lines
152 assert_eq!(truncate_lines_to_byte_limit(text, 13), "Line 1\n");
153 assert_eq!(truncate_lines_to_byte_limit(text, 20), "Line 1\nLine 2\n");
154
155 // Limit before first newline
156 assert_eq!(truncate_lines_to_byte_limit(text, 6), "Line ");
157
158 // Test with non-ASCII characters
159 let text_utf8 = "Line 1\nLΓne 2\nLine 3";
160 assert_eq!(
161 truncate_lines_to_byte_limit(text_utf8, 15),
162 "Line 1\nLΓne 2\n"
163 );
164}
165
166pub fn post_inc<T: From<u8> + AddAssign<T> + Copy>(value: &mut T) -> T {
167 let prev = *value;
168 *value += T::from(1);
169 prev
170}
171
172/// Extend a sorted vector with a sorted sequence of items, maintaining the vector's sort order and
173/// enforcing a maximum length. This also de-duplicates items. Sort the items according to the given callback. Before calling this,
174/// both `vec` and `new_items` should already be sorted according to the `cmp` comparator.
175pub fn extend_sorted<T, I, F>(vec: &mut Vec<T>, new_items: I, limit: usize, mut cmp: F)
176where
177 I: IntoIterator<Item = T>,
178 F: FnMut(&T, &T) -> Ordering,
179{
180 let mut start_index = 0;
181 for new_item in new_items {
182 if let Err(i) = vec[start_index..].binary_search_by(|m| cmp(m, &new_item)) {
183 let index = start_index + i;
184 if vec.len() < limit {
185 vec.insert(index, new_item);
186 } else if index < vec.len() {
187 vec.pop();
188 vec.insert(index, new_item);
189 }
190 start_index = index;
191 }
192 }
193}
194
195pub fn truncate_to_bottom_n_sorted_by<T, F>(items: &mut Vec<T>, limit: usize, compare: &F)
196where
197 F: Fn(&T, &T) -> Ordering,
198{
199 if limit == 0 {
200 items.truncate(0);
201 }
202 if items.len() <= limit {
203 items.sort_by(compare);
204 return;
205 }
206 // When limit is near to items.len() it may be more efficient to sort the whole list and
207 // truncate, rather than always doing selection first as is done below. It's hard to analyze
208 // where the threshold for this should be since the quickselect style algorithm used by
209 // `select_nth_unstable_by` makes the prefix partially sorted, and so its work is not wasted -
210 // the expected number of comparisons needed by `sort_by` is less than it is for some arbitrary
211 // unsorted input.
212 items.select_nth_unstable_by(limit, compare);
213 items.truncate(limit);
214 items.sort_by(compare);
215}
216
217/// Prevents execution of the application with root privileges on Unix systems.
218///
219/// This function checks if the current process is running with root privileges
220/// and terminates the program with an error message unless explicitly allowed via the
221/// `ZED_ALLOW_ROOT` environment variable.
222#[cfg(unix)]
223pub fn prevent_root_execution() {
224 let is_root = nix::unistd::geteuid().is_root();
225 let allow_root = std::env::var("ZED_ALLOW_ROOT").is_ok_and(|val| val == "true");
226
227 if is_root && !allow_root {
228 eprintln!(
229 "\
230Error: Running Zed as root or via sudo is unsupported.
231 Doing so (even once) may subtly break things for all subsequent non-root usage of Zed.
232 It is untested and not recommended, don't complain when things break.
233 If you wish to proceed anyways, set `ZED_ALLOW_ROOT=true` in your environment."
234 );
235 std::process::exit(1);
236 }
237}
238
239#[cfg(unix)]
240fn load_shell_from_passwd() -> Result<()> {
241 let buflen = match unsafe { libc::sysconf(libc::_SC_GETPW_R_SIZE_MAX) } {
242 n if n < 0 => 1024,
243 n => n as usize,
244 };
245 let mut buffer = Vec::with_capacity(buflen);
246
247 let mut pwd: std::mem::MaybeUninit<libc::passwd> = std::mem::MaybeUninit::uninit();
248 let mut result: *mut libc::passwd = std::ptr::null_mut();
249
250 let uid = unsafe { libc::getuid() };
251 let status = unsafe {
252 libc::getpwuid_r(
253 uid,
254 pwd.as_mut_ptr(),
255 buffer.as_mut_ptr() as *mut libc::c_char,
256 buflen,
257 &mut result,
258 )
259 };
260 let entry = unsafe { pwd.assume_init() };
261
262 anyhow::ensure!(
263 status == 0,
264 "call to getpwuid_r failed. uid: {}, status: {}",
265 uid,
266 status
267 );
268 anyhow::ensure!(!result.is_null(), "passwd entry for uid {} not found", uid);
269 anyhow::ensure!(
270 entry.pw_uid == uid,
271 "passwd entry has different uid ({}) than getuid ({}) returned",
272 entry.pw_uid,
273 uid,
274 );
275
276 let shell = unsafe { std::ffi::CStr::from_ptr(entry.pw_shell).to_str().unwrap() };
277 if env::var("SHELL").map_or(true, |shell_env| shell_env != shell) {
278 log::info!(
279 "updating SHELL environment variable to value from passwd entry: {:?}",
280 shell,
281 );
282 unsafe { env::set_var("SHELL", shell) };
283 }
284
285 Ok(())
286}
287
288#[cfg(unix)]
289/// Returns a shell escaped path for the current zed executable
290pub fn get_shell_safe_zed_path() -> anyhow::Result<String> {
291 use anyhow::Context;
292
293 let zed_path = std::env::current_exe()
294 .context("Failed to determine current zed executable path.")?
295 .to_string_lossy()
296 .trim_end_matches(" (deleted)") // see https://github.com/rust-lang/rust/issues/69343
297 .to_string();
298
299 // As of writing, this can only be fail if the path contains a null byte, which shouldn't be possible
300 // but shlex has annotated the error as #[non_exhaustive] so we can't make it a compile error if other
301 // errors are introduced in the future :(
302 let zed_path_escaped =
303 shlex::try_quote(&zed_path).context("Failed to shell-escape Zed executable path.")?;
304
305 return Ok(zed_path_escaped.to_string());
306}
307
308#[cfg(unix)]
309pub fn load_login_shell_environment() -> Result<()> {
310 load_shell_from_passwd().log_err();
311
312 // If possible, we want to `cd` in the user's `$HOME` to trigger programs
313 // such as direnv, asdf, mise, ... to adjust the PATH. These tools often hook
314 // into shell's `cd` command (and hooks) to manipulate env.
315 // We do this so that we get the env a user would have when spawning a shell
316 // in home directory.
317 for (name, value) in shell_env::capture(paths::home_dir())? {
318 unsafe { env::set_var(&name, &value) };
319 }
320
321 log::info!(
322 "set environment variables from shell:{}, path:{}",
323 std::env::var("SHELL").unwrap_or_default(),
324 std::env::var("PATH").unwrap_or_default(),
325 );
326
327 Ok(())
328}
329
330/// Configures the process to start a new session, to prevent interactive shells from taking control
331/// of the terminal.
332///
333/// For more details: https://registerspill.thorstenball.com/p/how-to-lose-control-of-your-shell
334pub fn set_pre_exec_to_start_new_session(
335 command: &mut std::process::Command,
336) -> &mut std::process::Command {
337 // safety: code in pre_exec should be signal safe.
338 // https://man7.org/linux/man-pages/man7/signal-safety.7.html
339 #[cfg(not(target_os = "windows"))]
340 unsafe {
341 use std::os::unix::process::CommandExt;
342 command.pre_exec(|| {
343 libc::setsid();
344 Ok(())
345 });
346 };
347 command
348}
349
350pub fn merge_json_lenient_value_into(
351 source: serde_json_lenient::Value,
352 target: &mut serde_json_lenient::Value,
353) {
354 match (source, target) {
355 (serde_json_lenient::Value::Object(source), serde_json_lenient::Value::Object(target)) => {
356 for (key, value) in source {
357 if let Some(target) = target.get_mut(&key) {
358 merge_json_lenient_value_into(value, target);
359 } else {
360 target.insert(key, value);
361 }
362 }
363 }
364
365 (serde_json_lenient::Value::Array(source), serde_json_lenient::Value::Array(target)) => {
366 for value in source {
367 target.push(value);
368 }
369 }
370
371 (source, target) => *target = source,
372 }
373}
374
375pub fn merge_json_value_into(source: serde_json::Value, target: &mut serde_json::Value) {
376 use serde_json::Value;
377
378 match (source, target) {
379 (Value::Object(source), Value::Object(target)) => {
380 for (key, value) in source {
381 if let Some(target) = target.get_mut(&key) {
382 merge_json_value_into(value, target);
383 } else {
384 target.insert(key, value);
385 }
386 }
387 }
388
389 (Value::Array(source), Value::Array(target)) => {
390 for value in source {
391 target.push(value);
392 }
393 }
394
395 (source, target) => *target = source,
396 }
397}
398
399pub fn merge_non_null_json_value_into(source: serde_json::Value, target: &mut serde_json::Value) {
400 use serde_json::Value;
401 if let Value::Object(source_object) = source {
402 let target_object = if let Value::Object(target) = target {
403 target
404 } else {
405 *target = Value::Object(Default::default());
406 target.as_object_mut().unwrap()
407 };
408 for (key, value) in source_object {
409 if let Some(target) = target_object.get_mut(&key) {
410 merge_non_null_json_value_into(value, target);
411 } else if !value.is_null() {
412 target_object.insert(key, value);
413 }
414 }
415 } else if !source.is_null() {
416 *target = source
417 }
418}
419
420pub fn measure<R>(label: &str, f: impl FnOnce() -> R) -> R {
421 static ZED_MEASUREMENTS: OnceLock<bool> = OnceLock::new();
422 let zed_measurements = ZED_MEASUREMENTS.get_or_init(|| {
423 env::var("ZED_MEASUREMENTS")
424 .map(|measurements| measurements == "1" || measurements == "true")
425 .unwrap_or(false)
426 });
427
428 if *zed_measurements {
429 let start = Instant::now();
430 let result = f();
431 let elapsed = start.elapsed();
432 eprintln!("{}: {:?}", label, elapsed);
433 result
434 } else {
435 f()
436 }
437}
438
439pub fn expanded_and_wrapped_usize_range(
440 range: Range<usize>,
441 additional_before: usize,
442 additional_after: usize,
443 wrap_length: usize,
444) -> impl Iterator<Item = usize> {
445 let start_wraps = range.start < additional_before;
446 let end_wraps = wrap_length < range.end + additional_after;
447 if start_wraps && end_wraps {
448 Either::Left(0..wrap_length)
449 } else if start_wraps {
450 let wrapped_start = (range.start + wrap_length).saturating_sub(additional_before);
451 if wrapped_start <= range.end {
452 Either::Left(0..wrap_length)
453 } else {
454 Either::Right((0..range.end + additional_after).chain(wrapped_start..wrap_length))
455 }
456 } else if end_wraps {
457 let wrapped_end = range.end + additional_after - wrap_length;
458 if range.start <= wrapped_end {
459 Either::Left(0..wrap_length)
460 } else {
461 Either::Right((0..wrapped_end).chain(range.start - additional_before..wrap_length))
462 }
463 } else {
464 Either::Left((range.start - additional_before)..(range.end + additional_after))
465 }
466}
467
468/// Yields `[i, i + 1, i - 1, i + 2, ..]`, each modulo `wrap_length` and bounded by
469/// `additional_before` and `additional_after`. If the wrapping causes overlap, duplicates are not
470/// emitted. If wrap_length is 0, nothing is yielded.
471pub fn wrapped_usize_outward_from(
472 start: usize,
473 additional_before: usize,
474 additional_after: usize,
475 wrap_length: usize,
476) -> impl Iterator<Item = usize> {
477 let mut count = 0;
478 let mut after_offset = 1;
479 let mut before_offset = 1;
480
481 std::iter::from_fn(move || {
482 count += 1;
483 if count > wrap_length {
484 None
485 } else if count == 1 {
486 Some(start % wrap_length)
487 } else if after_offset <= additional_after && after_offset <= before_offset {
488 let value = (start + after_offset) % wrap_length;
489 after_offset += 1;
490 Some(value)
491 } else if before_offset <= additional_before {
492 let value = (start + wrap_length - before_offset) % wrap_length;
493 before_offset += 1;
494 Some(value)
495 } else if after_offset <= additional_after {
496 let value = (start + after_offset) % wrap_length;
497 after_offset += 1;
498 Some(value)
499 } else {
500 None
501 }
502 })
503}
504
505#[cfg(target_os = "windows")]
506pub fn get_windows_system_shell() -> String {
507 use std::path::PathBuf;
508
509 fn find_pwsh_in_programfiles(find_alternate: bool, find_preview: bool) -> Option<PathBuf> {
510 #[cfg(target_pointer_width = "64")]
511 let env_var = if find_alternate {
512 "ProgramFiles(x86)"
513 } else {
514 "ProgramFiles"
515 };
516
517 #[cfg(target_pointer_width = "32")]
518 let env_var = if find_alternate {
519 "ProgramW6432"
520 } else {
521 "ProgramFiles"
522 };
523
524 let install_base_dir = PathBuf::from(std::env::var_os(env_var)?).join("PowerShell");
525 install_base_dir
526 .read_dir()
527 .ok()?
528 .filter_map(Result::ok)
529 .filter(|entry| matches!(entry.file_type(), Ok(ft) if ft.is_dir()))
530 .filter_map(|entry| {
531 let dir_name = entry.file_name();
532 let dir_name = dir_name.to_string_lossy();
533
534 let version = if find_preview {
535 let dash_index = dir_name.find('-')?;
536 if &dir_name[dash_index + 1..] != "preview" {
537 return None;
538 };
539 dir_name[..dash_index].parse::<u32>().ok()?
540 } else {
541 dir_name.parse::<u32>().ok()?
542 };
543
544 let exe_path = entry.path().join("pwsh.exe");
545 if exe_path.exists() {
546 Some((version, exe_path))
547 } else {
548 None
549 }
550 })
551 .max_by_key(|(version, _)| *version)
552 .map(|(_, path)| path)
553 }
554
555 fn find_pwsh_in_msix(find_preview: bool) -> Option<PathBuf> {
556 let msix_app_dir =
557 PathBuf::from(std::env::var_os("LOCALAPPDATA")?).join("Microsoft\\WindowsApps");
558 if !msix_app_dir.exists() {
559 return None;
560 }
561
562 let prefix = if find_preview {
563 "Microsoft.PowerShellPreview_"
564 } else {
565 "Microsoft.PowerShell_"
566 };
567 msix_app_dir
568 .read_dir()
569 .ok()?
570 .filter_map(|entry| {
571 let entry = entry.ok()?;
572 if !matches!(entry.file_type(), Ok(ft) if ft.is_dir()) {
573 return None;
574 }
575
576 if !entry.file_name().to_string_lossy().starts_with(prefix) {
577 return None;
578 }
579
580 let exe_path = entry.path().join("pwsh.exe");
581 exe_path.exists().then_some(exe_path)
582 })
583 .next()
584 }
585
586 fn find_pwsh_in_scoop() -> Option<PathBuf> {
587 let pwsh_exe =
588 PathBuf::from(std::env::var_os("USERPROFILE")?).join("scoop\\shims\\pwsh.exe");
589 pwsh_exe.exists().then_some(pwsh_exe)
590 }
591
592 static SYSTEM_SHELL: LazyLock<String> = LazyLock::new(|| {
593 find_pwsh_in_programfiles(false, false)
594 .or_else(|| find_pwsh_in_programfiles(true, false))
595 .or_else(|| find_pwsh_in_msix(false))
596 .or_else(|| find_pwsh_in_programfiles(false, true))
597 .or_else(|| find_pwsh_in_msix(true))
598 .or_else(|| find_pwsh_in_programfiles(true, true))
599 .or_else(find_pwsh_in_scoop)
600 .map(|p| p.to_string_lossy().to_string())
601 .unwrap_or("powershell.exe".to_string())
602 });
603
604 (*SYSTEM_SHELL).clone()
605}
606
607pub trait ResultExt<E> {
608 type Ok;
609
610 fn log_err(self) -> Option<Self::Ok>;
611 /// Assert that this result should never be an error in development or tests.
612 fn debug_assert_ok(self, reason: &str) -> Self;
613 fn warn_on_err(self) -> Option<Self::Ok>;
614 fn log_with_level(self, level: log::Level) -> Option<Self::Ok>;
615 fn anyhow(self) -> anyhow::Result<Self::Ok>
616 where
617 E: Into<anyhow::Error>;
618}
619
620impl<T, E> ResultExt<E> for Result<T, E>
621where
622 E: std::fmt::Debug,
623{
624 type Ok = T;
625
626 #[track_caller]
627 fn log_err(self) -> Option<T> {
628 self.log_with_level(log::Level::Error)
629 }
630
631 #[track_caller]
632 fn debug_assert_ok(self, reason: &str) -> Self {
633 if let Err(error) = &self {
634 debug_panic!("{reason} - {error:?}");
635 }
636 self
637 }
638
639 #[track_caller]
640 fn warn_on_err(self) -> Option<T> {
641 self.log_with_level(log::Level::Warn)
642 }
643
644 #[track_caller]
645 fn log_with_level(self, level: log::Level) -> Option<T> {
646 match self {
647 Ok(value) => Some(value),
648 Err(error) => {
649 log_error_with_caller(*Location::caller(), error, level);
650 None
651 }
652 }
653 }
654
655 fn anyhow(self) -> anyhow::Result<T>
656 where
657 E: Into<anyhow::Error>,
658 {
659 self.map_err(Into::into)
660 }
661}
662
663fn log_error_with_caller<E>(caller: core::panic::Location<'_>, error: E, level: log::Level)
664where
665 E: std::fmt::Debug,
666{
667 #[cfg(not(target_os = "windows"))]
668 let file = caller.file();
669 #[cfg(target_os = "windows")]
670 let file = caller.file().replace('\\', "/");
671 // In this codebase all crates reside in a `crates` directory,
672 // so discard the prefix up to that segment to find the crate name
673 let target = file
674 .split_once("crates/")
675 .and_then(|(_, s)| s.split_once('/'))
676 .map(|(p, _)| p);
677
678 log::logger().log(
679 &log::Record::builder()
680 .target(target.unwrap_or(""))
681 .module_path(target)
682 .args(format_args!("{:?}", error))
683 .file(Some(caller.file()))
684 .line(Some(caller.line()))
685 .level(level)
686 .build(),
687 );
688}
689
690pub fn log_err<E: std::fmt::Debug>(error: &E) {
691 log_error_with_caller(*Location::caller(), error, log::Level::Warn);
692}
693
694pub trait TryFutureExt {
695 fn log_err(self) -> LogErrorFuture<Self>
696 where
697 Self: Sized;
698
699 fn log_tracked_err(self, location: core::panic::Location<'static>) -> LogErrorFuture<Self>
700 where
701 Self: Sized;
702
703 fn warn_on_err(self) -> LogErrorFuture<Self>
704 where
705 Self: Sized;
706 fn unwrap(self) -> UnwrapFuture<Self>
707 where
708 Self: Sized;
709}
710
711impl<F, T, E> TryFutureExt for F
712where
713 F: Future<Output = Result<T, E>>,
714 E: std::fmt::Debug,
715{
716 #[track_caller]
717 fn log_err(self) -> LogErrorFuture<Self>
718 where
719 Self: Sized,
720 {
721 let location = Location::caller();
722 LogErrorFuture(self, log::Level::Error, *location)
723 }
724
725 fn log_tracked_err(self, location: core::panic::Location<'static>) -> LogErrorFuture<Self>
726 where
727 Self: Sized,
728 {
729 LogErrorFuture(self, log::Level::Error, location)
730 }
731
732 #[track_caller]
733 fn warn_on_err(self) -> LogErrorFuture<Self>
734 where
735 Self: Sized,
736 {
737 let location = Location::caller();
738 LogErrorFuture(self, log::Level::Warn, *location)
739 }
740
741 fn unwrap(self) -> UnwrapFuture<Self>
742 where
743 Self: Sized,
744 {
745 UnwrapFuture(self)
746 }
747}
748
749#[must_use]
750pub struct LogErrorFuture<F>(F, log::Level, core::panic::Location<'static>);
751
752impl<F, T, E> Future for LogErrorFuture<F>
753where
754 F: Future<Output = Result<T, E>>,
755 E: std::fmt::Debug,
756{
757 type Output = Option<T>;
758
759 fn poll(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Self::Output> {
760 let level = self.1;
761 let location = self.2;
762 let inner = unsafe { Pin::new_unchecked(&mut self.get_unchecked_mut().0) };
763 match inner.poll(cx) {
764 Poll::Ready(output) => Poll::Ready(match output {
765 Ok(output) => Some(output),
766 Err(error) => {
767 log_error_with_caller(location, error, level);
768 None
769 }
770 }),
771 Poll::Pending => Poll::Pending,
772 }
773 }
774}
775
776pub struct UnwrapFuture<F>(F);
777
778impl<F, T, E> Future for UnwrapFuture<F>
779where
780 F: Future<Output = Result<T, E>>,
781 E: std::fmt::Debug,
782{
783 type Output = T;
784
785 fn poll(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Self::Output> {
786 let inner = unsafe { Pin::new_unchecked(&mut self.get_unchecked_mut().0) };
787 match inner.poll(cx) {
788 Poll::Ready(result) => Poll::Ready(result.unwrap()),
789 Poll::Pending => Poll::Pending,
790 }
791 }
792}
793
794pub struct Deferred<F: FnOnce()>(Option<F>);
795
796impl<F: FnOnce()> Deferred<F> {
797 /// Drop without running the deferred function.
798 pub fn abort(mut self) {
799 self.0.take();
800 }
801}
802
803impl<F: FnOnce()> Drop for Deferred<F> {
804 fn drop(&mut self) {
805 if let Some(f) = self.0.take() {
806 f()
807 }
808 }
809}
810
811/// Run the given function when the returned value is dropped (unless it's cancelled).
812#[must_use]
813pub fn defer<F: FnOnce()>(f: F) -> Deferred<F> {
814 Deferred(Some(f))
815}
816
817#[cfg(any(test, feature = "test-support"))]
818mod rng {
819 use rand::{Rng, seq::SliceRandom};
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").map_or(false, |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.gen_range(0..100) < 5 {
845 Some('\n')
846 } else {
847 Some(self.rng.gen_range(b'a'..b'z' + 1).into())
848 };
849 }
850
851 match self.rng.gen_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.gen_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.gen_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
1061#[derive(Debug)]
1062pub enum ConnectionResult<O> {
1063 Timeout,
1064 ConnectionReset,
1065 Result(anyhow::Result<O>),
1066}
1067
1068impl<O> ConnectionResult<O> {
1069 pub fn into_response(self) -> anyhow::Result<O> {
1070 match self {
1071 ConnectionResult::Timeout => anyhow::bail!("Request timed out"),
1072 ConnectionResult::ConnectionReset => anyhow::bail!("Server reset the connection"),
1073 ConnectionResult::Result(r) => r,
1074 }
1075 }
1076}
1077
1078impl<O> From<anyhow::Result<O>> for ConnectionResult<O> {
1079 fn from(result: anyhow::Result<O>) -> Self {
1080 ConnectionResult::Result(result)
1081 }
1082}
1083
1084#[cfg(test)]
1085mod tests {
1086 use super::*;
1087
1088 #[test]
1089 fn test_extend_sorted() {
1090 let mut vec = vec![];
1091
1092 extend_sorted(&mut vec, vec![21, 17, 13, 8, 1, 0], 5, |a, b| b.cmp(a));
1093 assert_eq!(vec, &[21, 17, 13, 8, 1]);
1094
1095 extend_sorted(&mut vec, vec![101, 19, 17, 8, 2], 8, |a, b| b.cmp(a));
1096 assert_eq!(vec, &[101, 21, 19, 17, 13, 8, 2, 1]);
1097
1098 extend_sorted(&mut vec, vec![1000, 19, 17, 9, 5], 8, |a, b| b.cmp(a));
1099 assert_eq!(vec, &[1000, 101, 21, 19, 17, 13, 9, 8]);
1100 }
1101
1102 #[test]
1103 fn test_truncate_to_bottom_n_sorted_by() {
1104 let mut vec: Vec<u32> = vec![5, 2, 3, 4, 1];
1105 truncate_to_bottom_n_sorted_by(&mut vec, 10, &u32::cmp);
1106 assert_eq!(vec, &[1, 2, 3, 4, 5]);
1107
1108 vec = vec![5, 2, 3, 4, 1];
1109 truncate_to_bottom_n_sorted_by(&mut vec, 5, &u32::cmp);
1110 assert_eq!(vec, &[1, 2, 3, 4, 5]);
1111
1112 vec = vec![5, 2, 3, 4, 1];
1113 truncate_to_bottom_n_sorted_by(&mut vec, 4, &u32::cmp);
1114 assert_eq!(vec, &[1, 2, 3, 4]);
1115
1116 vec = vec![5, 2, 3, 4, 1];
1117 truncate_to_bottom_n_sorted_by(&mut vec, 1, &u32::cmp);
1118 assert_eq!(vec, &[1]);
1119
1120 vec = vec![5, 2, 3, 4, 1];
1121 truncate_to_bottom_n_sorted_by(&mut vec, 0, &u32::cmp);
1122 assert!(vec.is_empty());
1123 }
1124
1125 #[test]
1126 fn test_iife() {
1127 fn option_returning_function() -> Option<()> {
1128 None
1129 }
1130
1131 let foo = maybe!({
1132 option_returning_function()?;
1133 Some(())
1134 });
1135
1136 assert_eq!(foo, None);
1137 }
1138
1139 #[test]
1140 fn test_truncate_and_trailoff() {
1141 assert_eq!(truncate_and_trailoff("", 5), "");
1142 assert_eq!(truncate_and_trailoff("aaaaaa", 7), "aaaaaa");
1143 assert_eq!(truncate_and_trailoff("aaaaaa", 6), "aaaaaa");
1144 assert_eq!(truncate_and_trailoff("aaaaaa", 5), "aaaaaβ¦");
1145 assert_eq!(truncate_and_trailoff("èèèèèè", 7), "èèèèèè");
1146 assert_eq!(truncate_and_trailoff("èèèèèè", 6), "èèèèèè");
1147 assert_eq!(truncate_and_trailoff("èèèèèè", 5), "èèèèèβ¦");
1148 }
1149
1150 #[test]
1151 fn test_truncate_and_remove_front() {
1152 assert_eq!(truncate_and_remove_front("", 5), "");
1153 assert_eq!(truncate_and_remove_front("aaaaaa", 7), "aaaaaa");
1154 assert_eq!(truncate_and_remove_front("aaaaaa", 6), "aaaaaa");
1155 assert_eq!(truncate_and_remove_front("aaaaaa", 5), "β¦aaaaa");
1156 assert_eq!(truncate_and_remove_front("èèèèèè", 7), "èèèèèè");
1157 assert_eq!(truncate_and_remove_front("èèèèèè", 6), "èèèèèè");
1158 assert_eq!(truncate_and_remove_front("èèèèèè", 5), "β¦Γ¨Γ¨Γ¨Γ¨Γ¨");
1159 }
1160
1161 #[test]
1162 fn test_numeric_prefix_str_method() {
1163 let target = "1a";
1164 assert_eq!(
1165 NumericPrefixWithSuffix::from_numeric_prefixed_str(target),
1166 NumericPrefixWithSuffix(Some(1), "a")
1167 );
1168
1169 let target = "12ab";
1170 assert_eq!(
1171 NumericPrefixWithSuffix::from_numeric_prefixed_str(target),
1172 NumericPrefixWithSuffix(Some(12), "ab")
1173 );
1174
1175 let target = "12_ab";
1176 assert_eq!(
1177 NumericPrefixWithSuffix::from_numeric_prefixed_str(target),
1178 NumericPrefixWithSuffix(Some(12), "_ab")
1179 );
1180
1181 let target = "1_2ab";
1182 assert_eq!(
1183 NumericPrefixWithSuffix::from_numeric_prefixed_str(target),
1184 NumericPrefixWithSuffix(Some(1), "_2ab")
1185 );
1186
1187 let target = "1.2";
1188 assert_eq!(
1189 NumericPrefixWithSuffix::from_numeric_prefixed_str(target),
1190 NumericPrefixWithSuffix(Some(1), ".2")
1191 );
1192
1193 let target = "1.2_a";
1194 assert_eq!(
1195 NumericPrefixWithSuffix::from_numeric_prefixed_str(target),
1196 NumericPrefixWithSuffix(Some(1), ".2_a")
1197 );
1198
1199 let target = "12.2_a";
1200 assert_eq!(
1201 NumericPrefixWithSuffix::from_numeric_prefixed_str(target),
1202 NumericPrefixWithSuffix(Some(12), ".2_a")
1203 );
1204
1205 let target = "12a.2_a";
1206 assert_eq!(
1207 NumericPrefixWithSuffix::from_numeric_prefixed_str(target),
1208 NumericPrefixWithSuffix(Some(12), "a.2_a")
1209 );
1210 }
1211
1212 #[test]
1213 fn test_numeric_prefix_with_suffix() {
1214 let mut sorted = vec!["1-abc", "10", "11def", "2", "21-abc"];
1215 sorted.sort_by_key(|s| NumericPrefixWithSuffix::from_numeric_prefixed_str(s));
1216 assert_eq!(sorted, ["1-abc", "2", "10", "11def", "21-abc"]);
1217
1218 for numeric_prefix_less in ["numeric_prefix_less", "aaa", "~β’Β£"] {
1219 assert_eq!(
1220 NumericPrefixWithSuffix::from_numeric_prefixed_str(numeric_prefix_less),
1221 NumericPrefixWithSuffix(None, numeric_prefix_less),
1222 "String without numeric prefix `{numeric_prefix_less}` should not be converted into NumericPrefixWithSuffix"
1223 )
1224 }
1225 }
1226
1227 #[test]
1228 fn test_word_consists_of_emojis() {
1229 let words_to_test = vec![
1230 ("π¨βπ©βπ§βπ§ππ₯", true),
1231 ("π", true),
1232 ("!π", false),
1233 ("π!", false),
1234 ("π ", false),
1235 (" π", false),
1236 ("Test", false),
1237 ];
1238
1239 for (text, expected_result) in words_to_test {
1240 assert_eq!(word_consists_of_emojis(text), expected_result);
1241 }
1242 }
1243
1244 #[test]
1245 fn test_truncate_lines_and_trailoff() {
1246 let text = r#"Line 1
1247Line 2
1248Line 3"#;
1249
1250 assert_eq!(
1251 truncate_lines_and_trailoff(text, 2),
1252 r#"Line 1
1253β¦"#
1254 );
1255
1256 assert_eq!(
1257 truncate_lines_and_trailoff(text, 3),
1258 r#"Line 1
1259Line 2
1260β¦"#
1261 );
1262
1263 assert_eq!(
1264 truncate_lines_and_trailoff(text, 4),
1265 r#"Line 1
1266Line 2
1267Line 3"#
1268 );
1269 }
1270
1271 #[test]
1272 fn test_expanded_and_wrapped_usize_range() {
1273 // Neither wrap
1274 assert_eq!(
1275 expanded_and_wrapped_usize_range(2..4, 1, 1, 8).collect::<Vec<usize>>(),
1276 (1..5).collect::<Vec<usize>>()
1277 );
1278 // Start wraps
1279 assert_eq!(
1280 expanded_and_wrapped_usize_range(2..4, 3, 1, 8).collect::<Vec<usize>>(),
1281 ((0..5).chain(7..8)).collect::<Vec<usize>>()
1282 );
1283 // Start wraps all the way around
1284 assert_eq!(
1285 expanded_and_wrapped_usize_range(2..4, 5, 1, 8).collect::<Vec<usize>>(),
1286 (0..8).collect::<Vec<usize>>()
1287 );
1288 // Start wraps all the way around and past 0
1289 assert_eq!(
1290 expanded_and_wrapped_usize_range(2..4, 10, 1, 8).collect::<Vec<usize>>(),
1291 (0..8).collect::<Vec<usize>>()
1292 );
1293 // End wraps
1294 assert_eq!(
1295 expanded_and_wrapped_usize_range(3..5, 1, 4, 8).collect::<Vec<usize>>(),
1296 (0..1).chain(2..8).collect::<Vec<usize>>()
1297 );
1298 // End wraps all the way around
1299 assert_eq!(
1300 expanded_and_wrapped_usize_range(3..5, 1, 5, 8).collect::<Vec<usize>>(),
1301 (0..8).collect::<Vec<usize>>()
1302 );
1303 // End wraps all the way around and past the end
1304 assert_eq!(
1305 expanded_and_wrapped_usize_range(3..5, 1, 10, 8).collect::<Vec<usize>>(),
1306 (0..8).collect::<Vec<usize>>()
1307 );
1308 // Both start and end wrap
1309 assert_eq!(
1310 expanded_and_wrapped_usize_range(3..5, 4, 4, 8).collect::<Vec<usize>>(),
1311 (0..8).collect::<Vec<usize>>()
1312 );
1313 }
1314
1315 #[test]
1316 fn test_wrapped_usize_outward_from() {
1317 // No wrapping
1318 assert_eq!(
1319 wrapped_usize_outward_from(4, 2, 2, 10).collect::<Vec<usize>>(),
1320 vec![4, 5, 3, 6, 2]
1321 );
1322 // Wrapping at end
1323 assert_eq!(
1324 wrapped_usize_outward_from(8, 2, 3, 10).collect::<Vec<usize>>(),
1325 vec![8, 9, 7, 0, 6, 1]
1326 );
1327 // Wrapping at start
1328 assert_eq!(
1329 wrapped_usize_outward_from(1, 3, 2, 10).collect::<Vec<usize>>(),
1330 vec![1, 2, 0, 3, 9, 8]
1331 );
1332 // All values wrap around
1333 assert_eq!(
1334 wrapped_usize_outward_from(5, 10, 10, 8).collect::<Vec<usize>>(),
1335 vec![5, 6, 4, 7, 3, 0, 2, 1]
1336 );
1337 // None before / after
1338 assert_eq!(
1339 wrapped_usize_outward_from(3, 0, 0, 8).collect::<Vec<usize>>(),
1340 vec![3]
1341 );
1342 // Starting point already wrapped
1343 assert_eq!(
1344 wrapped_usize_outward_from(15, 2, 2, 10).collect::<Vec<usize>>(),
1345 vec![5, 6, 4, 7, 3]
1346 );
1347 // wrap_length of 0
1348 assert_eq!(
1349 wrapped_usize_outward_from(4, 2, 2, 0).collect::<Vec<usize>>(),
1350 Vec::<usize>::new()
1351 );
1352 }
1353
1354 #[test]
1355 fn test_split_with_ranges() {
1356 let input = "hi";
1357 let result = split_str_with_ranges(input, |c| c == ' ');
1358
1359 assert_eq!(result.len(), 1);
1360 assert_eq!(result[0], (0..2, "hi"));
1361
1362 let input = "hΓ©lloπ¦world";
1363 let result = split_str_with_ranges(input, |c| c == 'π¦');
1364
1365 assert_eq!(result.len(), 2);
1366 assert_eq!(result[0], (0..6, "hΓ©llo")); // 'Γ©' is 2 bytes
1367 assert_eq!(result[1], (10..15, "world")); // 'π¦' is 4 bytes
1368 }
1369}