use crate::command_registry::CommandRegistry; use crate::commands::help::get_help; use crate::deserializer::ConfigDeserializer; use crate::evaluate::evaluate_args::evaluate_args; use crate::prelude::*; use derive_new::new; use getset::Getters; use nu_errors::ShellError; use nu_protocol::hir; use nu_protocol::{CallInfo, EvaluatedArgs, ReturnSuccess, Scope, Signature, UntaggedValue, Value}; use parking_lot::Mutex; use serde::{Deserialize, Serialize}; use std::ops::Deref; use std::sync::atomic::AtomicBool; #[derive(Deserialize, Serialize, Debug, Clone)] pub struct UnevaluatedCallInfo { pub args: hir::Call, pub name_tag: Tag, pub scope: Arc, } impl UnevaluatedCallInfo { pub async fn evaluate(self, registry: &CommandRegistry) -> Result { let args = evaluate_args(&self.args, registry, self.scope.clone()).await?; Ok(CallInfo { args, name_tag: self.name_tag, }) } pub fn switch_present(&self, switch: &str) -> bool { self.args.switch_preset(switch) } } #[derive(Getters)] #[get = "pub(crate)"] pub struct CommandArgs { pub host: Arc>>, pub ctrl_c: Arc, pub current_errors: Arc>>, pub shell_manager: ShellManager, pub call_info: UnevaluatedCallInfo, pub input: InputStream, pub raw_input: String, } #[derive(Getters, Clone)] #[get = "pub(crate)"] pub struct RawCommandArgs { pub host: Arc>>, pub ctrl_c: Arc, pub current_errors: Arc>>, pub shell_manager: ShellManager, pub call_info: UnevaluatedCallInfo, } impl RawCommandArgs { pub fn with_input(self, input: impl Into) -> CommandArgs { CommandArgs { host: self.host, ctrl_c: self.ctrl_c, current_errors: self.current_errors, shell_manager: self.shell_manager, call_info: self.call_info, input: input.into(), raw_input: String::default(), } } } impl std::fmt::Debug for CommandArgs { fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { self.call_info.fmt(f) } } impl CommandArgs { pub async fn evaluate_once( self, registry: &CommandRegistry, ) -> Result { let host = self.host.clone(); let ctrl_c = self.ctrl_c.clone(); let shell_manager = self.shell_manager.clone(); let input = self.input; let call_info = self.call_info.evaluate(registry).await?; Ok(EvaluatedWholeStreamCommandArgs::new( host, ctrl_c, shell_manager, call_info, input, )) } pub async fn evaluate_once_with_scope( self, registry: &CommandRegistry, scope: Arc, ) -> Result { let host = self.host.clone(); let ctrl_c = self.ctrl_c.clone(); let shell_manager = self.shell_manager.clone(); let input = self.input; let call_info = UnevaluatedCallInfo { name_tag: self.call_info.name_tag, args: self.call_info.args, scope: scope.clone(), }; let call_info = call_info.evaluate(registry).await?; Ok(EvaluatedWholeStreamCommandArgs::new( host, ctrl_c, shell_manager, call_info, input, )) } pub async fn process<'de, T: Deserialize<'de>>( self, registry: &CommandRegistry, ) -> Result<(T, InputStream), ShellError> { let args = self.evaluate_once(registry).await?; let call_info = args.call_info.clone(); let mut deserializer = ConfigDeserializer::from_call_info(call_info); Ok((T::deserialize(&mut deserializer)?, args.input)) } } pub struct RunnableContext { pub input: InputStream, pub shell_manager: ShellManager, pub host: Arc>>, pub ctrl_c: Arc, pub current_errors: Arc>>, pub registry: CommandRegistry, pub name: Tag, pub raw_input: String, } impl RunnableContext { pub fn get_command(&self, name: &str) -> Option { self.registry.get_command(name) } } pub struct EvaluatedWholeStreamCommandArgs { pub args: EvaluatedCommandArgs, pub input: InputStream, } impl Deref for EvaluatedWholeStreamCommandArgs { type Target = EvaluatedCommandArgs; fn deref(&self) -> &Self::Target { &self.args } } impl EvaluatedWholeStreamCommandArgs { pub fn new( host: Arc>, ctrl_c: Arc, shell_manager: ShellManager, call_info: CallInfo, input: impl Into, ) -> EvaluatedWholeStreamCommandArgs { EvaluatedWholeStreamCommandArgs { args: EvaluatedCommandArgs { host, ctrl_c, shell_manager, call_info, }, input: input.into(), } } pub fn name_tag(&self) -> Tag { self.args.call_info.name_tag.clone() } pub fn parts(self) -> (InputStream, EvaluatedArgs) { let EvaluatedWholeStreamCommandArgs { args, input } = self; (input, args.call_info.args) } pub fn split(self) -> (InputStream, EvaluatedCommandArgs) { let EvaluatedWholeStreamCommandArgs { args, input } = self; (input, args) } } #[derive(Getters, new)] #[get = "pub(crate)"] pub struct EvaluatedCommandArgs { pub host: Arc>, pub ctrl_c: Arc, pub shell_manager: ShellManager, pub call_info: CallInfo, } impl EvaluatedCommandArgs { pub fn nth(&self, pos: usize) -> Option<&Value> { self.call_info.args.nth(pos) } /// Get the nth positional argument, error if not possible pub fn expect_nth(&self, pos: usize) -> Result<&Value, ShellError> { self.call_info .args .nth(pos) .ok_or_else(|| ShellError::unimplemented("Better error: expect_nth")) } pub fn get(&self, name: &str) -> Option<&Value> { self.call_info.args.get(name) } pub fn has(&self, name: &str) -> bool { self.call_info.args.has(name) } } pub struct Example { pub example: &'static str, pub description: &'static str, pub result: Option>, } #[async_trait] pub trait WholeStreamCommand: Send + Sync { fn name(&self) -> &str; fn signature(&self) -> Signature { Signature::new(self.name()).desc(self.usage()).filter() } fn usage(&self) -> &str; async fn run( &self, args: CommandArgs, registry: &CommandRegistry, ) -> Result; fn is_binary(&self) -> bool { false } // Commands that are not meant to be run by users fn is_internal(&self) -> bool { false } fn examples(&self) -> Vec { Vec::new() } } #[derive(Clone)] pub struct Command(Arc); impl PrettyDebugWithSource for Command { fn pretty_debug(&self, source: &str) -> DebugDocBuilder { b::typed( "whole stream command", b::description(self.name()) + b::space() + b::equals() + b::space() + self.signature().pretty_debug(source), ) } } impl std::fmt::Debug for Command { fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { write!(f, "Command({})", self.name()) } } impl Command { pub fn name(&self) -> &str { self.0.name() } pub fn signature(&self) -> Signature { self.0.signature() } pub fn usage(&self) -> &str { self.0.usage() } pub fn examples(&self) -> Vec { self.0.examples() } pub async fn run( &self, args: CommandArgs, registry: &CommandRegistry, ) -> Result { if args.call_info.switch_present("help") { let cl = self.0.clone(); let registry = registry.clone(); Ok(OutputStream::one(Ok(ReturnSuccess::Value( UntaggedValue::string(get_help(&*cl, ®istry)).into_value(Tag::unknown()), )))) } else { self.0.run(args, registry).await } } pub fn is_binary(&self) -> bool { self.0.is_binary() } pub fn is_internal(&self) -> bool { self.0.is_internal() } pub fn stream_command(&self) -> &dyn WholeStreamCommand { &*self.0 } } pub fn whole_stream_command(command: impl WholeStreamCommand + 'static) -> Command { Command(Arc::new(command)) }