2020-04-06 17:16:18 +00:00
|
|
|
use ansi_term::Style;
|
2020-07-07 22:45:32 +00:00
|
|
|
use pest::error::Error as PestError;
|
2020-04-06 17:16:18 +00:00
|
|
|
use rayon::prelude::*;
|
2020-07-07 22:45:32 +00:00
|
|
|
use std::borrow::Cow;
|
|
|
|
use std::collections::{BTreeMap, BTreeSet};
|
|
|
|
use std::error::Error;
|
|
|
|
use std::fmt;
|
2020-04-06 17:16:18 +00:00
|
|
|
|
|
|
|
use crate::config::parse_style_string;
|
2021-11-01 21:18:45 +00:00
|
|
|
use crate::context::{Context, Shell};
|
2020-04-06 17:16:18 +00:00
|
|
|
use crate::segment::Segment;
|
|
|
|
|
|
|
|
use super::model::*;
|
|
|
|
use super::parser::{parse, Rule};
|
|
|
|
|
2020-04-10 16:23:20 +00:00
|
|
|
#[derive(Clone)]
|
2020-07-07 22:45:32 +00:00
|
|
|
enum VariableValue<'a> {
|
|
|
|
Plain(Cow<'a, str>),
|
2021-11-01 21:18:45 +00:00
|
|
|
NoEscapingPlain(Cow<'a, str>),
|
2020-04-10 16:23:20 +00:00
|
|
|
Styled(Vec<Segment>),
|
2020-07-07 22:45:32 +00:00
|
|
|
Meta(Vec<FormatElement<'a>>),
|
2020-04-10 16:23:20 +00:00
|
|
|
}
|
|
|
|
|
2020-07-07 22:45:32 +00:00
|
|
|
impl<'a> Default for VariableValue<'a> {
|
2020-04-10 16:23:20 +00:00
|
|
|
fn default() -> Self {
|
2020-07-07 22:45:32 +00:00
|
|
|
VariableValue::Plain(Cow::Borrowed(""))
|
2020-04-10 16:23:20 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2020-07-07 22:45:32 +00:00
|
|
|
type VariableMapType<'a> =
|
|
|
|
BTreeMap<String, Option<Result<VariableValue<'a>, StringFormatterError>>>;
|
|
|
|
type StyleVariableMapType<'a> =
|
|
|
|
BTreeMap<String, Option<Result<Cow<'a, str>, StringFormatterError>>>;
|
|
|
|
|
2021-04-10 17:06:25 +00:00
|
|
|
#[derive(Debug, Clone, PartialEq)]
|
2020-07-07 22:45:32 +00:00
|
|
|
pub enum StringFormatterError {
|
|
|
|
Custom(String),
|
|
|
|
Parse(PestError<Rule>),
|
|
|
|
}
|
|
|
|
|
|
|
|
impl fmt::Display for StringFormatterError {
|
|
|
|
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
|
|
|
|
match self {
|
|
|
|
Self::Custom(error) => write!(f, "{}", error),
|
|
|
|
Self::Parse(error) => write!(f, "{}", error),
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
impl Error for StringFormatterError {}
|
|
|
|
|
|
|
|
impl From<String> for StringFormatterError {
|
|
|
|
fn from(error: String) -> Self {
|
2021-07-29 18:27:46 +00:00
|
|
|
Self::Custom(error)
|
2020-07-07 22:45:32 +00:00
|
|
|
}
|
|
|
|
}
|
2020-04-06 17:16:18 +00:00
|
|
|
|
|
|
|
pub struct StringFormatter<'a> {
|
|
|
|
format: Vec<FormatElement<'a>>,
|
2020-07-07 22:45:32 +00:00
|
|
|
variables: VariableMapType<'a>,
|
|
|
|
style_variables: StyleVariableMapType<'a>,
|
2020-04-06 17:16:18 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
impl<'a> StringFormatter<'a> {
|
|
|
|
/// Creates an instance of StringFormatter from a format string
|
2020-07-07 22:45:32 +00:00
|
|
|
///
|
|
|
|
/// This method will throw an Error when the given format string fails to parse.
|
|
|
|
pub fn new(format: &'a str) -> Result<Self, StringFormatterError> {
|
2021-01-17 21:35:33 +00:00
|
|
|
let format = parse(format).map_err(StringFormatterError::Parse)?;
|
|
|
|
|
|
|
|
// Cache all variables
|
|
|
|
let variables = format
|
|
|
|
.get_variables()
|
|
|
|
.into_iter()
|
|
|
|
.map(|key| (key.to_string(), None))
|
|
|
|
.collect::<VariableMapType>();
|
|
|
|
|
|
|
|
let style_variables = format
|
|
|
|
.get_style_variables()
|
|
|
|
.into_iter()
|
|
|
|
.map(|key| (key.to_string(), None))
|
|
|
|
.collect::<StyleVariableMapType>();
|
|
|
|
|
|
|
|
Ok(Self {
|
|
|
|
format,
|
|
|
|
variables,
|
|
|
|
style_variables,
|
|
|
|
})
|
2020-04-06 17:16:18 +00:00
|
|
|
}
|
|
|
|
|
2021-09-08 19:45:27 +00:00
|
|
|
/// A StringFormatter that does no formatting, parse just returns the raw text
|
|
|
|
pub fn raw(text: &'a str) -> Self {
|
|
|
|
Self {
|
|
|
|
format: vec![FormatElement::Text(text.into())],
|
|
|
|
variables: BTreeMap::new(),
|
|
|
|
style_variables: BTreeMap::new(),
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2020-04-06 17:16:18 +00:00
|
|
|
/// Maps variable name to its value
|
2020-07-07 22:45:32 +00:00
|
|
|
///
|
|
|
|
/// You should provide a function or closure that accepts the variable name `name: &str` as a
|
|
|
|
/// parameter and returns the one of the following values:
|
|
|
|
///
|
|
|
|
/// - `None`: This variable will be reserved for further mappers. If it is `None` when
|
|
|
|
/// `self.parse()` is called, it will be dropped.
|
|
|
|
///
|
|
|
|
/// - `Some(Err(StringFormatterError))`: This variable will throws `StringFormatterError` when
|
|
|
|
/// `self.parse()` is called. Return this if some fatal error occurred and the format string
|
|
|
|
/// should not be rendered.
|
|
|
|
///
|
|
|
|
/// - `Some(Ok(_))`: The value of this variable will be displayed in the format string.
|
|
|
|
///
|
|
|
|
pub fn map<T, M>(mut self, mapper: M) -> Self
|
|
|
|
where
|
|
|
|
T: Into<Cow<'a, str>>,
|
|
|
|
M: Fn(&str) -> Option<Result<T, StringFormatterError>> + Sync,
|
|
|
|
{
|
|
|
|
self.variables
|
|
|
|
.par_iter_mut()
|
|
|
|
.filter(|(_, value)| value.is_none())
|
|
|
|
.for_each(|(key, value)| {
|
|
|
|
*value = mapper(key).map(|var| var.map(|var| VariableValue::Plain(var.into())));
|
|
|
|
});
|
|
|
|
self
|
|
|
|
}
|
|
|
|
|
2021-11-01 21:18:45 +00:00
|
|
|
/// Maps variable name into a value which is wrapped to prevent escaping later
|
|
|
|
///
|
|
|
|
/// This should be used for variables that should not be escaped before inclusion in the prompt
|
|
|
|
///
|
|
|
|
/// See `StringFormatter::map` for description on the parameters.
|
|
|
|
///
|
|
|
|
pub fn map_no_escaping<T, M>(mut self, mapper: M) -> Self
|
|
|
|
where
|
|
|
|
T: Into<Cow<'a, str>>,
|
|
|
|
M: Fn(&str) -> Option<Result<T, StringFormatterError>> + Sync,
|
|
|
|
{
|
|
|
|
self.variables
|
|
|
|
.par_iter_mut()
|
|
|
|
.filter(|(_, value)| value.is_none())
|
|
|
|
.for_each(|(key, value)| {
|
|
|
|
*value = mapper(key)
|
|
|
|
.map(|var| var.map(|var| VariableValue::NoEscapingPlain(var.into())));
|
|
|
|
});
|
|
|
|
self
|
|
|
|
}
|
|
|
|
|
2020-07-07 22:45:32 +00:00
|
|
|
/// Maps a meta-variable to a format string containing other variables.
|
|
|
|
///
|
|
|
|
/// This function should be called **before** other map methods so that variables found in
|
|
|
|
/// the format strings of meta-variables can be cached properly.
|
|
|
|
///
|
|
|
|
/// See `StringFormatter::map` for description on the parameters.
|
|
|
|
pub fn map_meta<M>(mut self, mapper: M) -> Self
|
|
|
|
where
|
|
|
|
M: Fn(&str, &BTreeSet<String>) -> Option<&'a str> + Sync,
|
|
|
|
{
|
|
|
|
let variables = self.get_variables();
|
|
|
|
let (variables, style_variables) = self
|
|
|
|
.variables
|
|
|
|
.iter_mut()
|
|
|
|
.filter(|(_, value)| value.is_none())
|
|
|
|
.fold(
|
|
|
|
(VariableMapType::new(), StyleVariableMapType::new()),
|
|
|
|
|(mut v, mut sv), (key, value)| {
|
|
|
|
*value = mapper(key, &variables).map(|format| {
|
|
|
|
StringFormatter::new(format).map(|formatter| {
|
|
|
|
let StringFormatter {
|
|
|
|
format,
|
|
|
|
mut variables,
|
|
|
|
mut style_variables,
|
|
|
|
} = formatter;
|
|
|
|
|
|
|
|
// Add variables in meta variables to self
|
|
|
|
v.append(&mut variables);
|
|
|
|
sv.append(&mut style_variables);
|
|
|
|
|
|
|
|
VariableValue::Meta(format)
|
|
|
|
})
|
|
|
|
});
|
|
|
|
|
|
|
|
(v, sv)
|
|
|
|
},
|
|
|
|
);
|
|
|
|
|
|
|
|
self.variables.extend(variables);
|
|
|
|
self.style_variables.extend(style_variables);
|
|
|
|
|
2020-04-06 17:16:18 +00:00
|
|
|
self
|
|
|
|
}
|
|
|
|
|
|
|
|
/// Maps variable name to an array of segments
|
2020-07-07 22:45:32 +00:00
|
|
|
///
|
|
|
|
/// See `StringFormatter::map` for description on the parameters.
|
|
|
|
pub fn map_variables_to_segments<M>(mut self, mapper: M) -> Self
|
|
|
|
where
|
|
|
|
M: Fn(&str) -> Option<Result<Vec<Segment>, StringFormatterError>> + Sync,
|
|
|
|
{
|
|
|
|
self.variables
|
|
|
|
.par_iter_mut()
|
|
|
|
.filter(|(_, value)| value.is_none())
|
|
|
|
.for_each(|(key, value)| {
|
|
|
|
*value = mapper(key).map(|var| var.map(VariableValue::Styled));
|
|
|
|
});
|
|
|
|
self
|
|
|
|
}
|
|
|
|
|
|
|
|
/// Maps variable name in a style string to its value
|
|
|
|
///
|
|
|
|
/// See `StringFormatter::map` for description on the parameters.
|
|
|
|
pub fn map_style<T, M>(mut self, mapper: M) -> Self
|
|
|
|
where
|
|
|
|
T: Into<Cow<'a, str>>,
|
|
|
|
M: Fn(&str) -> Option<Result<T, StringFormatterError>> + Sync,
|
|
|
|
{
|
|
|
|
self.style_variables
|
|
|
|
.par_iter_mut()
|
|
|
|
.filter(|(_, value)| value.is_none())
|
|
|
|
.for_each(|(key, value)| {
|
2021-07-29 18:27:46 +00:00
|
|
|
*value = mapper(key).map(|var| var.map(std::convert::Into::into));
|
2020-07-07 22:45:32 +00:00
|
|
|
});
|
2020-04-06 17:16:18 +00:00
|
|
|
self
|
|
|
|
}
|
|
|
|
|
|
|
|
/// Parse the format string and consume self.
|
2020-07-07 22:45:32 +00:00
|
|
|
///
|
|
|
|
/// This method will throw an Error in the following conditions:
|
|
|
|
///
|
|
|
|
/// - Format string in meta variables fails to parse
|
|
|
|
/// - Variable mapper returns an error.
|
2021-11-01 21:18:45 +00:00
|
|
|
pub fn parse(
|
|
|
|
self,
|
|
|
|
default_style: Option<Style>,
|
|
|
|
context: Option<&Context>,
|
|
|
|
) -> Result<Vec<Segment>, StringFormatterError> {
|
2020-08-17 02:16:05 +00:00
|
|
|
fn parse_textgroup<'a>(
|
2020-04-06 17:16:18 +00:00
|
|
|
textgroup: TextGroup<'a>,
|
2020-07-07 22:45:32 +00:00
|
|
|
variables: &'a VariableMapType<'a>,
|
|
|
|
style_variables: &'a StyleVariableMapType<'a>,
|
2021-11-01 21:18:45 +00:00
|
|
|
context: Option<&Context>,
|
2020-07-07 22:45:32 +00:00
|
|
|
) -> Result<Vec<Segment>, StringFormatterError> {
|
2020-08-17 02:16:05 +00:00
|
|
|
let style = parse_style(textgroup.style, style_variables);
|
|
|
|
parse_format(
|
2020-07-07 22:45:32 +00:00
|
|
|
textgroup.format,
|
|
|
|
style.transpose()?,
|
2021-07-29 18:27:46 +00:00
|
|
|
variables,
|
|
|
|
style_variables,
|
2021-11-01 21:18:45 +00:00
|
|
|
context,
|
2020-07-07 22:45:32 +00:00
|
|
|
)
|
2020-04-06 17:16:18 +00:00
|
|
|
}
|
|
|
|
|
2020-08-17 02:16:05 +00:00
|
|
|
fn parse_style<'a>(
|
2020-07-07 22:45:32 +00:00
|
|
|
style: Vec<StyleElement>,
|
|
|
|
variables: &'a StyleVariableMapType<'a>,
|
|
|
|
) -> Option<Result<Style, StringFormatterError>> {
|
|
|
|
let style_strings = style
|
|
|
|
.into_iter()
|
|
|
|
.map(|style| match style {
|
|
|
|
StyleElement::Text(text) => Ok(text),
|
|
|
|
StyleElement::Variable(name) => {
|
|
|
|
let variable = variables.get(name.as_ref()).unwrap_or(&None);
|
|
|
|
match variable {
|
2020-10-13 16:03:33 +00:00
|
|
|
Some(style_string) => style_string.clone(),
|
2020-07-07 22:45:32 +00:00
|
|
|
None => Ok("".into()),
|
|
|
|
}
|
2020-04-06 17:16:18 +00:00
|
|
|
}
|
|
|
|
})
|
2020-07-07 22:45:32 +00:00
|
|
|
.collect::<Result<Vec<Cow<str>>, StringFormatterError>>();
|
|
|
|
style_strings
|
|
|
|
.map(|style_strings| {
|
|
|
|
let style_string: String =
|
|
|
|
style_strings.iter().flat_map(|s| s.chars()).collect();
|
|
|
|
parse_style_string(&style_string)
|
|
|
|
})
|
|
|
|
.transpose()
|
2020-04-06 17:16:18 +00:00
|
|
|
}
|
|
|
|
|
2020-08-17 02:16:05 +00:00
|
|
|
fn parse_format<'a>(
|
2020-07-07 22:45:32 +00:00
|
|
|
format: Vec<FormatElement<'a>>,
|
2020-04-06 17:16:18 +00:00
|
|
|
style: Option<Style>,
|
2020-07-07 22:45:32 +00:00
|
|
|
variables: &'a VariableMapType<'a>,
|
|
|
|
style_variables: &'a StyleVariableMapType<'a>,
|
2021-11-01 21:18:45 +00:00
|
|
|
context: Option<&Context>,
|
2020-07-07 22:45:32 +00:00
|
|
|
) -> Result<Vec<Segment>, StringFormatterError> {
|
|
|
|
let results: Result<Vec<Vec<Segment>>, StringFormatterError> = format
|
|
|
|
.into_iter()
|
|
|
|
.map(|el| {
|
|
|
|
match el {
|
2021-09-12 23:59:15 +00:00
|
|
|
FormatElement::Text(text) => Ok(Segment::from_text(style, text)),
|
2020-07-07 22:45:32 +00:00
|
|
|
FormatElement::TextGroup(textgroup) => {
|
|
|
|
let textgroup = TextGroup {
|
|
|
|
format: textgroup.format,
|
|
|
|
style: textgroup.style,
|
|
|
|
};
|
2021-11-01 21:18:45 +00:00
|
|
|
parse_textgroup(textgroup, variables, style_variables, context)
|
2020-07-07 22:45:32 +00:00
|
|
|
}
|
|
|
|
FormatElement::Variable(name) => variables
|
|
|
|
.get(name.as_ref())
|
|
|
|
.expect("Uncached variable found")
|
|
|
|
.as_ref()
|
|
|
|
.map(|segments| match segments.clone()? {
|
|
|
|
VariableValue::Styled(segments) => Ok(segments
|
2020-04-10 16:23:20 +00:00
|
|
|
.into_iter()
|
|
|
|
.map(|mut segment| {
|
2020-07-07 22:45:32 +00:00
|
|
|
// Derive upper style if the style of segments are none.
|
2021-09-12 23:59:15 +00:00
|
|
|
segment.set_style_if_empty(style);
|
2020-04-10 16:23:20 +00:00
|
|
|
segment
|
|
|
|
})
|
2020-07-07 22:45:32 +00:00
|
|
|
.collect()),
|
2021-11-01 21:18:45 +00:00
|
|
|
VariableValue::Plain(text) => Ok(Segment::from_text(
|
|
|
|
style,
|
|
|
|
shell_prompt_escape(
|
|
|
|
text,
|
|
|
|
match context {
|
|
|
|
None => Shell::Unknown,
|
|
|
|
Some(c) => c.shell,
|
|
|
|
},
|
|
|
|
),
|
|
|
|
)),
|
|
|
|
VariableValue::NoEscapingPlain(text) => {
|
|
|
|
Ok(Segment::from_text(style, text))
|
|
|
|
}
|
2020-07-07 22:45:32 +00:00
|
|
|
VariableValue::Meta(format) => {
|
|
|
|
let formatter = StringFormatter {
|
|
|
|
format,
|
2020-08-17 02:16:05 +00:00
|
|
|
variables: clone_without_meta(variables),
|
2020-07-07 22:45:32 +00:00
|
|
|
style_variables: style_variables.clone(),
|
|
|
|
};
|
2021-11-01 21:18:45 +00:00
|
|
|
formatter.parse(style, context)
|
2020-04-10 16:23:20 +00:00
|
|
|
}
|
2020-07-07 22:45:32 +00:00
|
|
|
})
|
|
|
|
.unwrap_or_else(|| Ok(Vec::new())),
|
|
|
|
FormatElement::Conditional(format) => {
|
|
|
|
// Show the conditional format string if all the variables inside are not
|
2021-06-29 23:33:43 +00:00
|
|
|
// none or empty string.
|
2020-08-17 02:16:05 +00:00
|
|
|
fn should_show_elements<'a>(
|
2020-07-07 22:45:32 +00:00
|
|
|
format_elements: &[FormatElement],
|
|
|
|
variables: &'a VariableMapType<'a>,
|
|
|
|
) -> bool {
|
|
|
|
format_elements.get_variables().iter().any(|var| {
|
|
|
|
variables
|
|
|
|
.get(var.as_ref())
|
2021-07-29 18:27:46 +00:00
|
|
|
// false if can't find the variable in format string
|
|
|
|
.map_or(false, |map_result| {
|
2020-07-07 22:45:32 +00:00
|
|
|
let map_result = map_result.as_ref();
|
|
|
|
map_result
|
|
|
|
.and_then(|result| result.as_ref().ok())
|
2021-07-29 18:27:46 +00:00
|
|
|
// false if the variable is None or Err, or a meta variable
|
|
|
|
// that shouldn't show
|
|
|
|
.map_or(false, |result| match result {
|
2020-07-07 22:45:32 +00:00
|
|
|
// If the variable is a meta variable, also
|
|
|
|
// check the format string inside it.
|
|
|
|
VariableValue::Meta(meta_elements) => {
|
|
|
|
let meta_variables =
|
2020-08-17 02:16:05 +00:00
|
|
|
clone_without_meta(variables);
|
|
|
|
should_show_elements(
|
2021-07-29 18:27:46 +00:00
|
|
|
meta_elements,
|
2020-07-07 22:45:32 +00:00
|
|
|
&meta_variables,
|
|
|
|
)
|
|
|
|
}
|
2021-06-29 23:33:43 +00:00
|
|
|
VariableValue::Plain(plain_value) => {
|
|
|
|
!plain_value.is_empty()
|
|
|
|
}
|
2021-11-01 21:18:45 +00:00
|
|
|
VariableValue::NoEscapingPlain(
|
|
|
|
no_escaping_plain_value,
|
|
|
|
) => !no_escaping_plain_value.is_empty(),
|
2021-09-12 23:59:15 +00:00
|
|
|
VariableValue::Styled(segments) => segments
|
|
|
|
.iter()
|
|
|
|
.any(|x| !x.value().is_empty()),
|
2020-07-07 22:45:32 +00:00
|
|
|
})
|
|
|
|
})
|
|
|
|
})
|
2020-04-10 16:23:20 +00:00
|
|
|
}
|
2020-04-06 17:16:18 +00:00
|
|
|
|
2020-08-17 02:16:05 +00:00
|
|
|
let should_show: bool = should_show_elements(&format, variables);
|
2020-07-07 22:45:32 +00:00
|
|
|
|
|
|
|
if should_show {
|
2021-11-01 21:18:45 +00:00
|
|
|
parse_format(format, style, variables, style_variables, context)
|
2020-07-07 22:45:32 +00:00
|
|
|
} else {
|
|
|
|
Ok(Vec::new())
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
})
|
|
|
|
.collect();
|
|
|
|
Ok(results?.into_iter().flatten().collect())
|
2020-04-06 17:16:18 +00:00
|
|
|
}
|
|
|
|
|
2020-08-17 02:16:05 +00:00
|
|
|
parse_format(
|
2020-07-07 22:45:32 +00:00
|
|
|
self.format,
|
|
|
|
default_style,
|
|
|
|
&self.variables,
|
|
|
|
&self.style_variables,
|
2021-11-01 21:18:45 +00:00
|
|
|
context,
|
2020-07-07 22:45:32 +00:00
|
|
|
)
|
2020-04-06 17:16:18 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2020-07-07 22:45:32 +00:00
|
|
|
impl<'a> VariableHolder<String> for StringFormatter<'a> {
|
|
|
|
fn get_variables(&self) -> BTreeSet<String> {
|
2020-11-23 19:38:11 +00:00
|
|
|
self.variables.keys().cloned().collect()
|
2020-04-06 17:16:18 +00:00
|
|
|
}
|
2020-07-07 22:45:32 +00:00
|
|
|
}
|
2020-04-06 17:16:18 +00:00
|
|
|
|
2020-07-07 22:45:32 +00:00
|
|
|
impl<'a> StyleVariableHolder<String> for StringFormatter<'a> {
|
|
|
|
fn get_style_variables(&self) -> BTreeSet<String> {
|
2020-11-23 19:38:11 +00:00
|
|
|
self.style_variables.keys().cloned().collect()
|
2020-04-06 17:16:18 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2020-08-17 02:16:05 +00:00
|
|
|
fn clone_without_meta<'a>(variables: &VariableMapType<'a>) -> VariableMapType<'a> {
|
2020-11-23 19:38:11 +00:00
|
|
|
variables
|
|
|
|
.iter()
|
|
|
|
.map(|(key, value)| {
|
|
|
|
let value = match value {
|
|
|
|
Some(Ok(value)) => match value {
|
|
|
|
VariableValue::Meta(_) => None,
|
|
|
|
other => Some(Ok(other.clone())),
|
|
|
|
},
|
|
|
|
Some(Err(e)) => Some(Err(e.clone())),
|
|
|
|
None => None,
|
|
|
|
};
|
|
|
|
(key.clone(), value)
|
|
|
|
})
|
|
|
|
.collect()
|
2020-07-07 22:45:32 +00:00
|
|
|
}
|
|
|
|
|
2021-11-01 21:18:45 +00:00
|
|
|
/// Escape interpretable characters for the shell prompt
|
|
|
|
pub fn shell_prompt_escape<T>(text: T, shell: Shell) -> String
|
|
|
|
where
|
|
|
|
T: Into<String>,
|
|
|
|
{
|
|
|
|
// Handle other interpretable characters
|
|
|
|
match shell {
|
|
|
|
// Bash might interepret baskslashes, backticks and $
|
|
|
|
// see #658 for more details
|
|
|
|
Shell::Bash => text
|
|
|
|
.into()
|
|
|
|
.replace('\\', r"\\")
|
|
|
|
.replace('$', r"\$")
|
|
|
|
.replace('`', r"\`"),
|
|
|
|
Shell::Zsh => {
|
|
|
|
// % is an escape in zsh, see PROMPT in `man zshmisc`
|
|
|
|
text.into().replace('%', "%%")
|
|
|
|
}
|
|
|
|
_ => text.into(),
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2020-04-06 17:16:18 +00:00
|
|
|
#[cfg(test)]
|
|
|
|
mod tests {
|
|
|
|
use super::*;
|
|
|
|
use ansi_term::Color;
|
|
|
|
|
2020-07-07 22:45:32 +00:00
|
|
|
// match_next(result: IterMut<Segment>, value, style)
|
2020-04-06 17:16:18 +00:00
|
|
|
macro_rules! match_next {
|
|
|
|
($iter:ident, $value:literal, $($style:tt)+) => {
|
|
|
|
let _next = $iter.next().unwrap();
|
2021-09-12 23:59:15 +00:00
|
|
|
assert_eq!(_next.value(), $value);
|
|
|
|
assert_eq!(_next.style(), $($style)+);
|
2020-04-06 17:16:18 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2020-07-07 22:45:32 +00:00
|
|
|
fn empty_mapper(_: &str) -> Option<Result<String, StringFormatterError>> {
|
2020-04-06 17:16:18 +00:00
|
|
|
None
|
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn test_default_style() {
|
|
|
|
const FORMAT_STR: &str = "text";
|
|
|
|
let style = Some(Color::Red.bold());
|
|
|
|
|
|
|
|
let formatter = StringFormatter::new(FORMAT_STR).unwrap().map(empty_mapper);
|
2021-11-01 21:18:45 +00:00
|
|
|
let result = formatter.parse(style, None).unwrap();
|
2020-04-06 17:16:18 +00:00
|
|
|
let mut result_iter = result.iter();
|
|
|
|
match_next!(result_iter, "text", style);
|
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn test_textgroup_text_only() {
|
|
|
|
const FORMAT_STR: &str = "[text](red bold)";
|
|
|
|
let formatter = StringFormatter::new(FORMAT_STR).unwrap().map(empty_mapper);
|
2021-11-01 21:18:45 +00:00
|
|
|
let result = formatter.parse(None, None).unwrap();
|
2020-04-06 17:16:18 +00:00
|
|
|
let mut result_iter = result.iter();
|
|
|
|
match_next!(result_iter, "text", Some(Color::Red.bold()));
|
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn test_variable_only() {
|
|
|
|
const FORMAT_STR: &str = "$var1";
|
|
|
|
|
|
|
|
let formatter = StringFormatter::new(FORMAT_STR)
|
|
|
|
.unwrap()
|
|
|
|
.map(|variable| match variable {
|
2020-07-07 22:45:32 +00:00
|
|
|
"var1" => Some(Ok("text1".to_owned())),
|
2020-04-06 17:16:18 +00:00
|
|
|
_ => None,
|
|
|
|
});
|
2021-11-01 21:18:45 +00:00
|
|
|
let result = formatter.parse(None, None).unwrap();
|
2020-04-06 17:16:18 +00:00
|
|
|
let mut result_iter = result.iter();
|
|
|
|
match_next!(result_iter, "text1", None);
|
|
|
|
}
|
|
|
|
|
2020-07-07 22:45:32 +00:00
|
|
|
#[test]
|
|
|
|
fn test_variable_in_style() {
|
|
|
|
const FORMAT_STR: &str = "[root]($style)";
|
|
|
|
let root_style = Some(Color::Red.bold());
|
|
|
|
|
|
|
|
let formatter = StringFormatter::new(FORMAT_STR)
|
|
|
|
.unwrap()
|
|
|
|
.map_style(|variable| match variable {
|
|
|
|
"style" => Some(Ok("red bold".to_owned())),
|
|
|
|
_ => None,
|
|
|
|
});
|
2021-11-01 21:18:45 +00:00
|
|
|
let result = formatter.parse(None, None).unwrap();
|
2020-07-07 22:45:32 +00:00
|
|
|
let mut result_iter = result.iter();
|
|
|
|
match_next!(result_iter, "root", root_style);
|
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn test_scoped_variable() {
|
|
|
|
const FORMAT_STR: &str = "${env:PWD}";
|
|
|
|
|
|
|
|
let formatter = StringFormatter::new(FORMAT_STR)
|
|
|
|
.unwrap()
|
|
|
|
.map(|variable| Some(Ok(format!("${{{}}}", variable))));
|
2021-11-01 21:18:45 +00:00
|
|
|
let result = formatter.parse(None, None).unwrap();
|
2020-07-07 22:45:32 +00:00
|
|
|
let mut result_iter = result.iter();
|
|
|
|
match_next!(result_iter, "${env:PWD}", None);
|
|
|
|
}
|
|
|
|
|
2020-04-06 17:16:18 +00:00
|
|
|
#[test]
|
|
|
|
fn test_escaped_chars() {
|
|
|
|
const FORMAT_STR: &str = r#"\\\[\$text\]\(red bold\)"#;
|
|
|
|
|
|
|
|
let formatter = StringFormatter::new(FORMAT_STR).unwrap().map(empty_mapper);
|
2021-11-01 21:18:45 +00:00
|
|
|
let result = formatter.parse(None, None).unwrap();
|
2020-04-06 17:16:18 +00:00
|
|
|
let mut result_iter = result.iter();
|
|
|
|
match_next!(result_iter, r#"\[$text](red bold)"#, None);
|
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn test_nested_textgroup() {
|
|
|
|
const FORMAT_STR: &str = "outer [middle [inner](blue)](red bold)";
|
|
|
|
let outer_style = Some(Color::Green.normal());
|
|
|
|
let middle_style = Some(Color::Red.bold());
|
|
|
|
let inner_style = Some(Color::Blue.normal());
|
|
|
|
|
|
|
|
let formatter = StringFormatter::new(FORMAT_STR).unwrap().map(empty_mapper);
|
2021-11-01 21:18:45 +00:00
|
|
|
let result = formatter.parse(outer_style, None).unwrap();
|
2020-04-06 17:16:18 +00:00
|
|
|
let mut result_iter = result.iter();
|
|
|
|
match_next!(result_iter, "outer ", outer_style);
|
|
|
|
match_next!(result_iter, "middle ", middle_style);
|
|
|
|
match_next!(result_iter, "inner", inner_style);
|
|
|
|
}
|
|
|
|
|
2020-04-10 16:23:20 +00:00
|
|
|
#[test]
|
|
|
|
fn test_styled_variable_as_text() {
|
|
|
|
const FORMAT_STR: &str = "[$var](red bold)";
|
|
|
|
let var_style = Some(Color::Red.bold());
|
|
|
|
|
|
|
|
let formatter = StringFormatter::new(FORMAT_STR)
|
|
|
|
.unwrap()
|
|
|
|
.map(|variable| match variable {
|
2020-07-07 22:45:32 +00:00
|
|
|
"var" => Some(Ok("text".to_owned())),
|
2020-04-10 16:23:20 +00:00
|
|
|
_ => None,
|
|
|
|
});
|
2021-11-01 21:18:45 +00:00
|
|
|
let result = formatter.parse(None, None).unwrap();
|
2020-04-10 16:23:20 +00:00
|
|
|
let mut result_iter = result.iter();
|
|
|
|
match_next!(result_iter, "text", var_style);
|
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn test_styled_variable_as_segments() {
|
|
|
|
const FORMAT_STR: &str = "[$var](red bold)";
|
|
|
|
let var_style = Some(Color::Red.bold());
|
|
|
|
let styled_style = Some(Color::Green.italic());
|
|
|
|
let styled_no_modifier_style = Some(Color::Green.normal());
|
|
|
|
|
2021-09-12 23:59:15 +00:00
|
|
|
let mut segments: Vec<Segment> = Vec::new();
|
|
|
|
segments.extend(Segment::from_text(None, "styless"));
|
|
|
|
segments.extend(Segment::from_text(styled_style, "styled"));
|
|
|
|
segments.extend(Segment::from_text(
|
|
|
|
styled_no_modifier_style,
|
|
|
|
"styled_no_modifier",
|
|
|
|
));
|
|
|
|
|
2020-04-10 16:23:20 +00:00
|
|
|
let formatter = StringFormatter::new(FORMAT_STR)
|
|
|
|
.unwrap()
|
|
|
|
.map_variables_to_segments(|variable| match variable {
|
2021-09-12 23:59:15 +00:00
|
|
|
"var" => Some(Ok(segments.clone())),
|
2020-04-10 16:23:20 +00:00
|
|
|
_ => None,
|
|
|
|
});
|
2021-11-01 21:18:45 +00:00
|
|
|
let result = formatter.parse(None, None).unwrap();
|
2020-04-10 16:23:20 +00:00
|
|
|
let mut result_iter = result.iter();
|
|
|
|
match_next!(result_iter, "styless", var_style);
|
|
|
|
match_next!(result_iter, "styled", styled_style);
|
|
|
|
match_next!(result_iter, "styled_no_modifier", styled_no_modifier_style);
|
|
|
|
}
|
|
|
|
|
2020-07-07 22:45:32 +00:00
|
|
|
#[test]
|
|
|
|
fn test_meta_variable() {
|
|
|
|
const FORMAT_STR: &str = "$all";
|
|
|
|
const FORMAT_STR__ALL: &str = "$a$b";
|
|
|
|
|
|
|
|
let formatter = StringFormatter::new(FORMAT_STR)
|
|
|
|
.unwrap()
|
|
|
|
.map_meta(|var, _| match var {
|
|
|
|
"all" => Some(FORMAT_STR__ALL),
|
|
|
|
_ => None,
|
|
|
|
})
|
|
|
|
.map(|var| match var {
|
|
|
|
"a" => Some(Ok("$a")),
|
|
|
|
"b" => Some(Ok("$b")),
|
|
|
|
_ => None,
|
|
|
|
});
|
2021-11-01 21:18:45 +00:00
|
|
|
let result = formatter.parse(None, None).unwrap();
|
2020-07-07 22:45:32 +00:00
|
|
|
let mut result_iter = result.iter();
|
|
|
|
match_next!(result_iter, "$a", None);
|
|
|
|
match_next!(result_iter, "$b", None);
|
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn test_multiple_mapper() {
|
|
|
|
const FORMAT_STR: &str = "$a$b$c";
|
|
|
|
|
|
|
|
let formatter = StringFormatter::new(FORMAT_STR)
|
|
|
|
.unwrap()
|
|
|
|
.map(|var| match var {
|
|
|
|
"a" => Some(Ok("$a")),
|
|
|
|
"b" => Some(Ok("$b")),
|
|
|
|
_ => None,
|
|
|
|
})
|
|
|
|
.map(|var| match var {
|
|
|
|
"b" => Some(Ok("$B")),
|
|
|
|
"c" => Some(Ok("$c")),
|
|
|
|
_ => None,
|
|
|
|
});
|
2021-11-01 21:18:45 +00:00
|
|
|
let result = formatter.parse(None, None).unwrap();
|
2020-07-07 22:45:32 +00:00
|
|
|
let mut result_iter = result.iter();
|
|
|
|
match_next!(result_iter, "$a", None);
|
|
|
|
match_next!(result_iter, "$b", None);
|
|
|
|
match_next!(result_iter, "$c", None);
|
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn test_conditional() {
|
|
|
|
const FORMAT_STR: &str = "($some) should render but ($none) shouldn't";
|
|
|
|
|
|
|
|
let formatter = StringFormatter::new(FORMAT_STR)
|
|
|
|
.unwrap()
|
|
|
|
.map(|var| match var {
|
|
|
|
"some" => Some(Ok("$some")),
|
|
|
|
_ => None,
|
|
|
|
});
|
2021-11-01 21:18:45 +00:00
|
|
|
let result = formatter.parse(None, None).unwrap();
|
2020-07-07 22:45:32 +00:00
|
|
|
let mut result_iter = result.iter();
|
|
|
|
match_next!(result_iter, "$some", None);
|
|
|
|
match_next!(result_iter, " should render but ", None);
|
|
|
|
match_next!(result_iter, " shouldn't", None);
|
|
|
|
}
|
|
|
|
|
2021-06-29 23:33:43 +00:00
|
|
|
#[test]
|
|
|
|
fn test_empty() {
|
|
|
|
const FORMAT_STR: &str = "(@$empty)";
|
|
|
|
|
|
|
|
let formatter = StringFormatter::new(FORMAT_STR)
|
|
|
|
.unwrap()
|
|
|
|
.map(|var| match var {
|
|
|
|
"empty" => Some(Ok("")),
|
|
|
|
_ => None,
|
|
|
|
});
|
2021-11-01 21:18:45 +00:00
|
|
|
let result = formatter.parse(None, None).unwrap();
|
2021-06-29 23:33:43 +00:00
|
|
|
assert_eq!(result.len(), 0);
|
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn test_styled_empty() {
|
|
|
|
const FORMAT_STR: &str = "[(@$empty)](red bold)";
|
|
|
|
|
|
|
|
let formatter = StringFormatter::new(FORMAT_STR)
|
|
|
|
.unwrap()
|
|
|
|
.map(|variable| match variable {
|
|
|
|
"empty" => Some(Ok("")),
|
|
|
|
_ => None,
|
|
|
|
});
|
2021-11-01 21:18:45 +00:00
|
|
|
let result = formatter.parse(None, None).unwrap();
|
2021-06-29 23:33:43 +00:00
|
|
|
assert_eq!(result.len(), 0);
|
|
|
|
}
|
|
|
|
|
2020-07-07 22:45:32 +00:00
|
|
|
#[test]
|
|
|
|
fn test_nested_conditional() {
|
|
|
|
const FORMAT_STR: &str = "($some ($none)) and ($none ($some))";
|
|
|
|
|
|
|
|
let formatter = StringFormatter::new(FORMAT_STR)
|
|
|
|
.unwrap()
|
|
|
|
.map(|var| match var {
|
|
|
|
"some" => Some(Ok("$some")),
|
|
|
|
_ => None,
|
|
|
|
});
|
2021-11-01 21:18:45 +00:00
|
|
|
let result = formatter.parse(None, None).unwrap();
|
2020-07-07 22:45:32 +00:00
|
|
|
let mut result_iter = result.iter();
|
|
|
|
match_next!(result_iter, "$some", None);
|
|
|
|
match_next!(result_iter, " ", None);
|
|
|
|
match_next!(result_iter, " and ", None);
|
|
|
|
match_next!(result_iter, " ", None);
|
|
|
|
match_next!(result_iter, "$some", None);
|
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn test_conditional_meta_variable() {
|
|
|
|
const FORMAT_STR: &str = r"(\[$all\]) ";
|
|
|
|
|
|
|
|
let formatter = StringFormatter::new(FORMAT_STR)
|
|
|
|
.unwrap()
|
|
|
|
.map_meta(|var, _| match var {
|
|
|
|
"all" => Some("$some"),
|
|
|
|
_ => None,
|
|
|
|
});
|
2021-11-01 21:18:45 +00:00
|
|
|
let result = formatter.parse(None, None).unwrap();
|
2020-07-07 22:45:32 +00:00
|
|
|
let mut result_iter = result.iter();
|
|
|
|
match_next!(result_iter, " ", None);
|
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn test_variable_holder() {
|
|
|
|
const FORMAT_STR: &str = "($a [($b) $c](none $s)) $d [t]($t)";
|
2021-01-01 18:45:04 +00:00
|
|
|
let expected_variables = vec!["a", "b", "c", "d"]
|
|
|
|
.into_iter()
|
|
|
|
.map(String::from)
|
|
|
|
.collect();
|
2020-07-07 22:45:32 +00:00
|
|
|
|
|
|
|
let formatter = StringFormatter::new(FORMAT_STR).unwrap().map(empty_mapper);
|
|
|
|
let variables = formatter.get_variables();
|
|
|
|
assert_eq!(variables, expected_variables);
|
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn test_style_variable_holder() {
|
|
|
|
const FORMAT_STR: &str = "($a [($b) $c](none $s)) $d [t]($t)";
|
2021-01-01 18:45:04 +00:00
|
|
|
let expected_variables = vec!["s", "t"].into_iter().map(String::from).collect();
|
2020-07-07 22:45:32 +00:00
|
|
|
|
|
|
|
let formatter = StringFormatter::new(FORMAT_STR).unwrap().map(empty_mapper);
|
|
|
|
let variables = formatter.get_style_variables();
|
|
|
|
assert_eq!(variables, expected_variables);
|
|
|
|
}
|
|
|
|
|
2020-04-06 17:16:18 +00:00
|
|
|
#[test]
|
|
|
|
fn test_parse_error() {
|
|
|
|
// brackets without escape
|
|
|
|
{
|
|
|
|
const FORMAT_STR: &str = "[";
|
|
|
|
assert!(StringFormatter::new(FORMAT_STR).is_err());
|
|
|
|
}
|
|
|
|
// Dollar without variable
|
|
|
|
{
|
|
|
|
const FORMAT_STR: &str = "$ ";
|
|
|
|
assert!(StringFormatter::new(FORMAT_STR).is_err());
|
|
|
|
}
|
|
|
|
}
|
2020-07-07 22:45:32 +00:00
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn test_variable_error() {
|
|
|
|
const FORMAT_STR: &str = "$never$some";
|
|
|
|
let never_error = StringFormatterError::Custom("NEVER".to_owned());
|
|
|
|
|
|
|
|
let segments = StringFormatter::new(FORMAT_STR).and_then(|formatter| {
|
|
|
|
formatter
|
|
|
|
.map(|var| match var {
|
|
|
|
"some" => Some(Ok("some")),
|
|
|
|
"never" => Some(Err(never_error.clone())),
|
|
|
|
_ => None,
|
|
|
|
})
|
2021-11-01 21:18:45 +00:00
|
|
|
.parse(None, None)
|
2020-07-07 22:45:32 +00:00
|
|
|
});
|
|
|
|
assert!(segments.is_err());
|
|
|
|
}
|
2021-11-01 21:18:45 +00:00
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn test_bash_escape() {
|
|
|
|
let test = "$(echo a)";
|
|
|
|
assert_eq!(
|
|
|
|
shell_prompt_escape(test.to_owned(), Shell::Bash),
|
|
|
|
r"\$(echo a)"
|
|
|
|
);
|
|
|
|
assert_eq!(
|
|
|
|
shell_prompt_escape(test.to_owned(), Shell::PowerShell),
|
|
|
|
test
|
|
|
|
);
|
|
|
|
|
|
|
|
let test = r"\$(echo a)";
|
|
|
|
assert_eq!(
|
|
|
|
shell_prompt_escape(test.to_owned(), Shell::Bash),
|
|
|
|
r"\\\$(echo a)"
|
|
|
|
);
|
|
|
|
assert_eq!(
|
|
|
|
shell_prompt_escape(test.to_owned(), Shell::PowerShell),
|
|
|
|
test
|
|
|
|
);
|
|
|
|
|
|
|
|
let test = r"`echo a`";
|
|
|
|
assert_eq!(
|
|
|
|
shell_prompt_escape(test.to_owned(), Shell::Bash),
|
|
|
|
r"\`echo a\`"
|
|
|
|
);
|
|
|
|
assert_eq!(
|
|
|
|
shell_prompt_escape(test.to_owned(), Shell::PowerShell),
|
|
|
|
test
|
|
|
|
);
|
|
|
|
}
|
|
|
|
#[test]
|
|
|
|
fn test_zsh_escape() {
|
|
|
|
let test = "10%";
|
|
|
|
assert_eq!(shell_prompt_escape(test.to_owned(), Shell::Zsh), "10%%");
|
|
|
|
assert_eq!(
|
|
|
|
shell_prompt_escape(test.to_owned(), Shell::PowerShell),
|
|
|
|
test
|
|
|
|
);
|
|
|
|
}
|
2020-04-06 17:16:18 +00:00
|
|
|
}
|