399a7c8836
# Description This PR introduces a new `Signals` struct to replace our adhoc passing around of `ctrlc: Option<Arc<AtomicBool>>`. Doing so has a few benefits: - We can better enforce when/where resetting or triggering an interrupt is allowed. - Consolidates `nu_utils::ctrl_c::was_pressed` and other ad-hoc re-implementations into a single place: `Signals::check`. - This allows us to add other types of signals later if we want. E.g., exiting or suspension. - Similarly, we can more easily change the underlying implementation if we need to in the future. - Places that used to have a `ctrlc` of `None` now use `Signals::empty()`, so we can double check these usages for correctness in the future.
94 lines
2.6 KiB
Rust
94 lines
2.6 KiB
Rust
use nu_engine::command_prelude::*;
|
|
|
|
#[derive(Clone)]
|
|
pub struct Debug;
|
|
|
|
impl Command for Debug {
|
|
fn name(&self) -> &str {
|
|
"debug"
|
|
}
|
|
|
|
fn usage(&self) -> &str {
|
|
"Debug print the value(s) piped in."
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
Signature::build("debug")
|
|
.input_output_types(vec![
|
|
(
|
|
Type::List(Box::new(Type::Any)),
|
|
Type::List(Box::new(Type::String)),
|
|
),
|
|
(Type::Any, Type::String),
|
|
])
|
|
.category(Category::Debug)
|
|
.switch("raw", "Prints the raw value representation", Some('r'))
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
engine_state: &EngineState,
|
|
stack: &mut Stack,
|
|
call: &Call,
|
|
input: PipelineData,
|
|
) -> Result<PipelineData, ShellError> {
|
|
let head = call.head;
|
|
let config = engine_state.get_config().clone();
|
|
let raw = call.has_flag(engine_state, stack, "raw")?;
|
|
|
|
// Should PipelineData::Empty result in an error here?
|
|
|
|
input.map(
|
|
move |x| {
|
|
if raw {
|
|
Value::string(x.to_debug_string(), head)
|
|
} else {
|
|
Value::string(x.to_expanded_string(", ", &config), head)
|
|
}
|
|
},
|
|
engine_state.signals(),
|
|
)
|
|
}
|
|
|
|
fn examples(&self) -> Vec<Example> {
|
|
vec![
|
|
Example {
|
|
description: "Debug print a string",
|
|
example: "'hello' | debug",
|
|
result: Some(Value::test_string("hello")),
|
|
},
|
|
Example {
|
|
description: "Debug print a list",
|
|
example: "['hello'] | debug",
|
|
result: Some(Value::list(
|
|
vec![Value::test_string("hello")],
|
|
Span::test_data(),
|
|
)),
|
|
},
|
|
Example {
|
|
description: "Debug print a table",
|
|
example:
|
|
"[[version patch]; ['0.1.0' false] ['0.1.1' true] ['0.2.0' false]] | debug",
|
|
result: Some(Value::list(
|
|
vec![
|
|
Value::test_string("{version: 0.1.0, patch: false}"),
|
|
Value::test_string("{version: 0.1.1, patch: true}"),
|
|
Value::test_string("{version: 0.2.0, patch: false}"),
|
|
],
|
|
Span::test_data(),
|
|
)),
|
|
},
|
|
]
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod test {
|
|
#[test]
|
|
fn test_examples() {
|
|
use super::Debug;
|
|
use crate::test_examples;
|
|
test_examples(Debug {})
|
|
}
|
|
}
|