mirror of
https://github.com/nushell/nushell.git
synced 2024-11-07 17:14:23 +01:00
Porting 'char' command from nushell to engine-q (#500)
* Port 'char' command from nushell to engine-q * fixed unit tests * Actually fixed unit tests
This commit is contained in:
Matthew Auld
GitHub
parent
e289630920
commit
89e2169521
@ -101,6 +101,7 @@ pub fn create_default_context() -> EngineState {
|
||||
// Strings
|
||||
bind_command! {
|
||||
BuildString,
|
||||
Char,
|
||||
Format,
|
||||
Parse,
|
||||
Size,
|
||||
|
||||
@ -18,6 +18,7 @@ pub fn test_examples(cmd: impl Command + 'static) {
|
||||
// Try to keep this working set small to keep tests running as fast as possible
|
||||
let mut working_set = StateWorkingSet::new(&*engine_state);
|
||||
working_set.add_decl(Box::new(Str));
|
||||
working_set.add_decl(Box::new(StrCollect));
|
||||
working_set.add_decl(Box::new(From));
|
||||
working_set.add_decl(Box::new(To));
|
||||
working_set.add_decl(Box::new(Into));
|
||||
|
||||
264
crates/nu-command/src/strings/char_.rs
Normal file
264
crates/nu-command/src/strings/char_.rs
Normal file
@ -0,0 +1,264 @@
|
||||
use indexmap::indexmap;
|
||||
use indexmap::map::IndexMap;
|
||||
use lazy_static::lazy_static;
|
||||
use nu_engine::CallExt;
|
||||
use nu_protocol::{
|
||||
ast::Call, engine::Command, Example, IntoInterruptiblePipelineData, IntoPipelineData,
|
||||
PipelineData, ShellError, Signature, Span, SyntaxShape, Value,
|
||||
};
|
||||
|
||||
// Character used to separate directories in a Path Environment variable on windows is ";"
|
||||
#[cfg(target_family = "windows")]
|
||||
const ENV_PATH_SEPARATOR_CHAR: char = ';';
|
||||
// Character used to separate directories in a Path Environment variable on linux/mac/unix is ":"
|
||||
#[cfg(not(target_family = "windows"))]
|
||||
const ENV_PATH_SEPARATOR_CHAR: char = ':';
|
||||
|
||||
#[derive(Clone)]
|
||||
pub struct Char;
|
||||
|
||||
lazy_static! {
|
||||
static ref CHAR_MAP: IndexMap<&'static str, String> = indexmap! {
|
||||
// These are some regular characters that either can't be used or
|
||||
// it's just easier to use them like this.
|
||||
|
||||
// This are the "normal" characters section
|
||||
"newline" => '\n'.to_string(),
|
||||
"enter" => '\n'.to_string(),
|
||||
"nl" => '\n'.to_string(),
|
||||
"tab" => '\t'.to_string(),
|
||||
"sp" => ' '.to_string(),
|
||||
"space" => ' '.to_string(),
|
||||
"pipe" => '|'.to_string(),
|
||||
"left_brace" => '{'.to_string(),
|
||||
"lbrace" => '{'.to_string(),
|
||||
"right_brace" => '}'.to_string(),
|
||||
"rbrace" => '}'.to_string(),
|
||||
"left_paren" => '('.to_string(),
|
||||
"lparen" => '('.to_string(),
|
||||
"right_paren" => ')'.to_string(),
|
||||
"rparen" => ')'.to_string(),
|
||||
"left_bracket" => '['.to_string(),
|
||||
"lbracket" => '['.to_string(),
|
||||
"right_bracket" => ']'.to_string(),
|
||||
"rbracket" => ']'.to_string(),
|
||||
"single_quote" => '\''.to_string(),
|
||||
"squote" => '\''.to_string(),
|
||||
"sq" => '\''.to_string(),
|
||||
"double_quote" => '\"'.to_string(),
|
||||
"dquote" => '\"'.to_string(),
|
||||
"dq" => '\"'.to_string(),
|
||||
"path_sep" => std::path::MAIN_SEPARATOR.to_string(),
|
||||
"psep" => std::path::MAIN_SEPARATOR.to_string(),
|
||||
"separator" => std::path::MAIN_SEPARATOR.to_string(),
|
||||
"esep" => ENV_PATH_SEPARATOR_CHAR.to_string(),
|
||||
"env_sep" => ENV_PATH_SEPARATOR_CHAR.to_string(),
|
||||
"tilde" => '~'.to_string(), // ~
|
||||
"twiddle" => '~'.to_string(), // ~
|
||||
"squiggly" => '~'.to_string(), // ~
|
||||
"home" => '~'.to_string(), // ~
|
||||
"hash" => '#'.to_string(), // #
|
||||
"hashtag" => '#'.to_string(), // #
|
||||
"pound_sign" => '#'.to_string(), // #
|
||||
"sharp" => '#'.to_string(), // #
|
||||
"root" => '#'.to_string(), // #
|
||||
|
||||
// This is the unicode section
|
||||
// Unicode names came from https://www.compart.com/en/unicode
|
||||
// Private Use Area (U+E000-U+F8FF)
|
||||
// Unicode can't be mixed with Ansi or it will break width calculation
|
||||
"branch" => '\u{e0a0}'.to_string(), //
|
||||
"segment" => '\u{e0b0}'.to_string(), //
|
||||
|
||||
"identical_to" => '\u{2261}'.to_string(), // ≡
|
||||
"hamburger" => '\u{2261}'.to_string(), // ≡
|
||||
"not_identical_to" => '\u{2262}'.to_string(), // ≢
|
||||
"branch_untracked" => '\u{2262}'.to_string(), // ≢
|
||||
"strictly_equivalent_to" => '\u{2263}'.to_string(), // ≣
|
||||
"branch_identical" => '\u{2263}'.to_string(), // ≣
|
||||
|
||||
"upwards_arrow" => '\u{2191}'.to_string(), // ↑
|
||||
"branch_ahead" => '\u{2191}'.to_string(), // ↑
|
||||
"downwards_arrow" => '\u{2193}'.to_string(), // ↓
|
||||
"branch_behind" => '\u{2193}'.to_string(), // ↓
|
||||
"up_down_arrow" => '\u{2195}'.to_string(), // ↕
|
||||
"branch_ahead_behind" => '\u{2195}'.to_string(), // ↕
|
||||
|
||||
"black_right_pointing_triangle" => '\u{25b6}'.to_string(), // ▶
|
||||
"prompt" => '\u{25b6}'.to_string(), // ▶
|
||||
"vector_or_cross_product" => '\u{2a2f}'.to_string(), // ⨯
|
||||
"failed" => '\u{2a2f}'.to_string(), // ⨯
|
||||
"high_voltage_sign" => '\u{26a1}'.to_string(), // ⚡
|
||||
"elevated" => '\u{26a1}'.to_string(), // ⚡
|
||||
|
||||
// This is the emoji section
|
||||
// Weather symbols
|
||||
"sun" => "☀️".to_string(),
|
||||
"sunny" => "☀️".to_string(),
|
||||
"sunrise" => "☀️".to_string(),
|
||||
"moon" => "🌛".to_string(),
|
||||
"cloudy" => "☁️".to_string(),
|
||||
"cloud" => "☁️".to_string(),
|
||||
"clouds" => "☁️".to_string(),
|
||||
"rainy" => "🌦️".to_string(),
|
||||
"rain" => "🌦️".to_string(),
|
||||
"foggy" => "🌫️".to_string(),
|
||||
"fog" => "🌫️".to_string(),
|
||||
"mist" => '\u{2591}'.to_string(),
|
||||
"haze" => '\u{2591}'.to_string(),
|
||||
"snowy" => "❄️".to_string(),
|
||||
"snow" => "❄️".to_string(),
|
||||
"thunderstorm" => "🌩️".to_string(),
|
||||
"thunder" => "🌩️".to_string(),
|
||||
|
||||
// This is the "other" section
|
||||
"bel" => '\x07'.to_string(), // Terminal Bell
|
||||
"backspace" => '\x08'.to_string(), // Backspace
|
||||
};
|
||||
}
|
||||
|
||||
impl Command for Char {
|
||||
fn name(&self) -> &str {
|
||||
"char"
|
||||
}
|
||||
|
||||
fn signature(&self) -> Signature {
|
||||
Signature::build("char")
|
||||
.optional(
|
||||
"character",
|
||||
SyntaxShape::Any,
|
||||
"the name of the character to output",
|
||||
)
|
||||
.rest("rest", SyntaxShape::String, "multiple Unicode bytes")
|
||||
.switch("list", "List all supported character names", Some('l'))
|
||||
.switch("unicode", "Unicode string i.e. 1f378", Some('u'))
|
||||
}
|
||||
|
||||
fn usage(&self) -> &str {
|
||||
"Output special characters (e.g., 'newline')."
|
||||
}
|
||||
|
||||
fn examples(&self) -> Vec<Example> {
|
||||
vec![
|
||||
Example {
|
||||
description: "Output newline",
|
||||
example: r#"char newline"#,
|
||||
result: Some(Value::test_string("\n")),
|
||||
},
|
||||
Example {
|
||||
description: "Output prompt character, newline and a hamburger character",
|
||||
example: r#"echo [(char prompt) (char newline) (char hamburger)] | str collect"#,
|
||||
result: Some(Value::test_string("\u{25b6}\n\u{2261}")),
|
||||
},
|
||||
Example {
|
||||
description: "Output Unicode character",
|
||||
example: r#"char -u 1f378"#,
|
||||
result: Some(Value::test_string("\u{1f378}")),
|
||||
},
|
||||
Example {
|
||||
description: "Output multi-byte Unicode character",
|
||||
example: r#"char -u 1F468 200D 1F466 200D 1F466"#,
|
||||
result: Some(Value::test_string(
|
||||
"\u{1F468}\u{200D}\u{1F466}\u{200D}\u{1F466}",
|
||||
)),
|
||||
},
|
||||
]
|
||||
}
|
||||
|
||||
fn run(
|
||||
&self,
|
||||
engine_state: &nu_protocol::engine::EngineState,
|
||||
stack: &mut nu_protocol::engine::Stack,
|
||||
call: &Call,
|
||||
_input: PipelineData,
|
||||
) -> Result<nu_protocol::PipelineData, ShellError> {
|
||||
let call_span = call.head;
|
||||
// handle -l flag
|
||||
if call.has_flag("list") {
|
||||
return Ok(CHAR_MAP
|
||||
.iter()
|
||||
.map(move |(name, s)| {
|
||||
let cols = vec!["name".into(), "character".into(), "unicode".into()];
|
||||
let name: Value = Value::string(String::from(*name), call_span);
|
||||
let character = Value::string(s, call_span);
|
||||
let unicode = Value::string(
|
||||
s.chars()
|
||||
.map(|c| format!("{:x}", c as u32))
|
||||
.collect::<Vec<String>>()
|
||||
.join(" "),
|
||||
call_span,
|
||||
);
|
||||
let vals = vec![name, character, unicode];
|
||||
Value::Record {
|
||||
cols,
|
||||
vals,
|
||||
span: call_span,
|
||||
}
|
||||
})
|
||||
.into_pipeline_data(engine_state.ctrlc.clone()));
|
||||
}
|
||||
// handle -u flag
|
||||
let args: Vec<String> = call.rest(engine_state, stack, 0)?;
|
||||
if call.has_flag("unicode") {
|
||||
if args.is_empty() {
|
||||
return Err(ShellError::MissingParameter(
|
||||
"missing at least one unicode character".into(),
|
||||
call_span,
|
||||
));
|
||||
}
|
||||
let mut multi_byte = String::new();
|
||||
for (i, arg) in args.iter().enumerate() {
|
||||
let span = call.nth(i).expect("Unexpected missing argument").span;
|
||||
multi_byte.push(string_to_unicode_char(arg, &span)?)
|
||||
}
|
||||
Ok(Value::string(multi_byte, call_span).into_pipeline_data())
|
||||
} else {
|
||||
if args.is_empty() {
|
||||
return Err(ShellError::MissingParameter(
|
||||
"missing name of the character".into(),
|
||||
call_span,
|
||||
));
|
||||
}
|
||||
let special_character = str_to_character(&args[0]);
|
||||
if let Some(output) = special_character {
|
||||
Ok(Value::string(output, call_span).into_pipeline_data())
|
||||
} else {
|
||||
Err(ShellError::UnsupportedInput(
|
||||
"error finding named character".into(),
|
||||
call.nth(0).expect("Unexpected missing argument").span,
|
||||
))
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
fn string_to_unicode_char(s: &str, t: &Span) -> Result<char, ShellError> {
|
||||
let decoded_char = u32::from_str_radix(s, 16)
|
||||
.ok()
|
||||
.and_then(std::char::from_u32);
|
||||
|
||||
if let Some(ch) = decoded_char {
|
||||
Ok(ch)
|
||||
} else {
|
||||
Err(ShellError::UnsupportedInput(
|
||||
"error decoding Unicode character".into(),
|
||||
*t,
|
||||
))
|
||||
}
|
||||
}
|
||||
|
||||
fn str_to_character(s: &str) -> Option<String> {
|
||||
CHAR_MAP.get(s).map(|s| s.into())
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::Char;
|
||||
|
||||
#[test]
|
||||
fn examples_work_as_expected() {
|
||||
use crate::test_examples;
|
||||
|
||||
test_examples(Char {})
|
||||
}
|
||||
}
|
||||
@ -1,4 +1,5 @@
|
||||
mod build_string;
|
||||
mod char_;
|
||||
mod format;
|
||||
mod parse;
|
||||
mod size;
|
||||
@ -6,6 +7,7 @@ mod split;
|
||||
mod str_;
|
||||
|
||||
pub use build_string::BuildString;
|
||||
pub use char_::Char;
|
||||
pub use format::*;
|
||||
pub use parse::*;
|
||||
pub use size::Size;
|
||||
|
||||
Loading…
Reference in New Issue
Block a user