erg/crates/erg_common/lib.rs

//! provides utilities for parser, compiler, and vm crate.
use std::fmt;
use std::path::PathBuf;

pub mod cache;
pub mod config;
pub mod consts;
pub mod datetime;
pub mod dict;
pub mod env;
pub mod erg_util;
pub mod error;
pub mod fresh;
pub mod fxhash;
pub mod help_messages;
pub mod lang;
pub mod levenshtein;
pub mod macros;
pub mod opcode;
pub mod opcode308;
pub mod opcode310;
pub mod opcode311;
pub mod pathutil;
pub mod python_util;
pub mod random;
pub mod serialize;
pub mod set;
pub mod shared;
pub mod spawn;
pub mod stdin;
pub mod str;
pub mod style;
pub mod traits;
pub mod triple;
pub mod tsort;

use crate::set::Set;
pub use crate::str::Str;
pub use crate::triple::Triple;

pub type ArcArray<T> = std::sync::Arc<[T]>;

pub fn open_read(filename: &str) -> std::io::Result<String> {
    let f = std::fs::File::open(filename)?;
    read_file(f)
}

pub fn read_file(mut f: std::fs::File) -> std::io::Result<String> {
    let mut s = "".to_string();
    std::io::Read::read_to_string(&mut f, &mut s).unwrap();
    Ok(s)
}

pub fn fmt_vec<T: fmt::Display>(v: &[T]) -> String {
    fmt_iter(v.iter())
}

pub fn fmt_slice<T: fmt::Display>(v: &[T]) -> String {
    fmt_iter(v.iter())
}

pub fn fmt_vec_split_with<T: fmt::Display>(v: &[T], splitter: &str) -> String {
    fmt_iter_split_with(v.iter(), splitter)
}

pub fn fmt_set_split_with<T: fmt::Display + std::hash::Hash>(s: &Set<T>, splitter: &str) -> String {
    fmt_iter_split_with(s.iter(), splitter)
}

pub fn debug_fmt_iter<T: fmt::Debug, I: Iterator<Item = T>>(iter: I) -> String {
    let mut s = iter.fold("".to_string(), |sum, elem| format!("{sum}{elem:?}, "));
    s.pop();
    s.pop();
    s
}

pub fn fmt_iter<T: fmt::Display, I: Iterator<Item = T>>(iter: I) -> String {
    let mut s = iter.fold("".to_string(), |sum, elem| sum + &elem.to_string() + ", ");
    s.pop();
    s.pop();
    s
}

pub fn fmt_iter_split_with<T: fmt::Display, I: Iterator<Item = T>>(i: I, splitter: &str) -> String {
    let mut s = i.fold("".to_string(), |sum, elem| {
        sum + &elem.to_string() + splitter
    });
    for _ in 0..splitter.len() {
        s.pop();
    }
    s
}

pub fn fmt_indent(s: String, depth: usize) -> String {
    let indent = " ".repeat(depth);
    s.split('\n').map(|s| indent.clone() + s).collect()
}

/// If you want to get a hash consisting of multiple objects, pass it as a tuple or array
pub fn get_hash<T: std::hash::Hash>(t: &T) -> usize {
    let mut s = fxhash::FxHasher::default();
    t.hash(&mut s);
    let res = std::hash::Hasher::finish(&s);
    if cfg!(target_pointer_width = "64") {
        res as usize
    } else {
        (res % usize::MAX as u64) as usize
    }
}

/// \r\n (Windows), \r (old MacOS) -> \n (Unix)
#[inline]
pub fn normalize_newline(src: &str) -> String {
    src.replace("\r\n", "\n").replace('\r', "\n")
}

/// cut \n
#[inline]
pub fn chomp(src: &str) -> String {
    normalize_newline(src).replace('\n', "")
}

pub fn try_map<T, U, E, F, I>(i: I, f: F) -> Result<Vec<U>, E>
where
    F: Fn(T) -> Result<U, E>,
    I: Iterator<Item = T>,
{
    let mut v = vec![];
    for x in i {
        let y = f(x)?;
        v.push(y);
    }
    Ok(v)
}

pub fn try_map_mut<T, U, E, F, I>(i: I, mut f: F) -> Result<Vec<U>, E>
where
    F: FnMut(T) -> Result<U, E>,
    I: Iterator<Item = T>,
{
    let mut v = vec![];
    for x in i {
        let y = f(x)?;
        v.push(y);
    }
    Ok(v)
}

pub fn unique_in_place<T: Eq + std::hash::Hash + Clone>(v: &mut Vec<T>) {
    let mut uniques = Set::new();
    v.retain(|e| uniques.insert(e.clone()));
}

/// at least, this is necessary for Windows and macOS
pub fn normalize_path(path: PathBuf) -> PathBuf {
    let verbatim_replaced = path.to_str().unwrap().replace("\\\\?\\", "");
    let lower = verbatim_replaced.to_lowercase();
    PathBuf::from(lower)
}

/// ```
/// use erg_common::trim_eliminate_top_indent;
/// let code = r#"
///     def foo():
///         pass
/// "#;
/// let expected = r#"def foo():
///     pass"#;
/// assert_eq!(trim_eliminate_top_indent(code.to_string()), expected);
/// ```
pub fn trim_eliminate_top_indent(code: String) -> String {
    let code = code.trim_matches(|c| c == '\n' || c == '\r');
    if !code.starts_with(' ') {
        return code.to_string();
    }
    let indent = code.chars().take_while(|c| *c == ' ').count();
    let mut result = String::new();
    for line in code.lines() {
        if line.len() > indent {
            result.push_str(line[indent..].trim_end());
        } else {
            result.push_str(line.trim_end());
        }
        result.push('\n');
    }
    if !result.is_empty() {
        result.pop();
    }
    result
}

pub fn deepen_indent(code: String) -> String {
    let mut result = String::new();
    for line in code.lines() {
        result.push_str("    ");
        result.push_str(line);
        result.push('\n');
    }
    if !result.is_empty() {
        result.pop();
    }
    result
}