aboutsummaryrefslogtreecommitdiff
path: root/mingling/src
diff options
context:
space:
mode:
Diffstat (limited to 'mingling/src')
-rw-r--r--mingling/src/example_docs.rs18
-rw-r--r--mingling/src/lib.md2
-rw-r--r--mingling/src/setups.rs3
-rw-r--r--mingling/src/setups/exit_code.rs11
-rw-r--r--mingling/src/setups/picker.rs10
-rw-r--r--mingling/src/setups/picker/basic.rs138
-rw-r--r--mingling/src/setups/picker/consts.rs105
-rw-r--r--mingling/src/setups/picker/structural_renderer.rs87
8 files changed, 362 insertions, 12 deletions
diff --git a/mingling/src/example_docs.rs b/mingling/src/example_docs.rs
index 4699a50..c4f59c9 100644
--- a/mingling/src/example_docs.rs
+++ b/mingling/src/example_docs.rs
@@ -66,7 +66,7 @@
/// // Convert into ResultFile
/// .into();
/// // --------- IMPORTANT ---------
-/// result
+/// result.into()
/// }
///
/// pack!(ErrorNoNameProvided = ());
@@ -199,7 +199,7 @@ pub mod example_argument_parse {}
/// // vvvvv_ `async` keyword can be used directly here
/// pub async fn handle_download(args: EntryDownload) -> Next {
/// let file_name = args.pick(()).unpack();
-/// fake_download(file_name).await
+/// fake_download(file_name).await.into()
/// }
///
/// /// Renders the downloaded file name.
@@ -292,7 +292,7 @@ pub mod example_async_support {}
/// .cloned()
/// .unwrap_or_else(|| "World".to_string())
/// .into();
-/// name
+/// name.into()
/// }
///
/// // Define renderer `render_name`, used to render `ResultName`
@@ -672,7 +672,7 @@ pub mod example_combine_pathf_dispatch_tree {}
/// .pick_or((), "World")
/// .unpack()
/// .into();
-/// result
+/// result.into()
/// }
///
/// /// Renders the greeting with the result name and repeat count.
@@ -1026,7 +1026,7 @@ pub mod example_dispatch_tree {}
/// fn handle_language_selection(args: EntryLanguageSelection) -> Next {
/// // You can use Picker to directly parse ProgrammingLanguages
/// let lang: ProgrammingLanguages = args.pick(()).unpack();
-/// lang
+/// lang.into()
/// }
///
/// /// Renders the selected programming language with its name and description.
@@ -1428,7 +1428,7 @@ pub mod example_help {}
/// .cloned()
/// .unwrap_or_else(|| "World".to_string())
/// .into();
-/// name
+/// name.into()
/// }
///
/// /// Renders the greeting message with the provided name.
@@ -1967,7 +1967,7 @@ pub mod example_pack_err {}
/// // Panic happens here, will be caught
/// panic!("{}", s)
/// }
-/// None => NotPanic::default(),
+/// None => NotPanic::default().into(),
/// }
/// }
///
@@ -2161,7 +2161,7 @@ pub mod example_pathfinder {}
/// #[chain]
/// fn parse_cd_args(prev: EntryCd) -> Next {
/// let join = prev.pick(()).unpack();
-/// StateChangeDirectory::new(join)
+/// StateChangeDirectory::new(join).into()
/// }
///
/// // Execute directory change
@@ -2323,7 +2323,7 @@ pub mod example_repl_basic {}
/// current_dir.current_dir = current_dir
/// .current_dir
/// .join(args.pick::<String>(()).unpack());
-/// EntryCurrent::default()
+/// EntryCurrent::default().into()
/// }
///
/// // Define renderer for output current path _____________ Injected resource
diff --git a/mingling/src/lib.md b/mingling/src/lib.md
index cd89b96..03fa61d 100644
--- a/mingling/src/lib.md
+++ b/mingling/src/lib.md
@@ -40,7 +40,7 @@ fn handle_greet(args: EntryGreet) -> Next {
.cloned()
.unwrap_or_else(|| "World".to_string())
.into();
- name
+ name.into()
}
#[renderer]
diff --git a/mingling/src/setups.rs b/mingling/src/setups.rs
index e572cf5..a1290ff 100644
--- a/mingling/src/setups.rs
+++ b/mingling/src/setups.rs
@@ -7,6 +7,9 @@ pub use dirs::*;
mod exit_code;
pub use exit_code::*;
+#[cfg(feature = "picker")]
+pub mod picker;
+
#[cfg(feature = "structural_renderer")]
mod structural_renderer;
diff --git a/mingling/src/setups/exit_code.rs b/mingling/src/setups/exit_code.rs
index 025ed8a..6b8a1ef 100644
--- a/mingling/src/setups/exit_code.rs
+++ b/mingling/src/setups/exit_code.rs
@@ -2,7 +2,7 @@ use std::marker::PhantomData;
use mingling_core::{
ProgramCollect,
- hook::{ProgramControlUnit, ProgramHook},
+ hook::{ProgramControlUnit, ProgramControls, ProgramHook},
setup::ProgramSetup,
this,
};
@@ -39,7 +39,14 @@ where
// Insert hook to override exit code before program ends
program.with_hook(ProgramHook::empty().on_finish(|_| {
let this = this::<C>().res_or_default::<ResExitCode>();
- ProgramControlUnit::OverrideExitCode(this.exit_code)
+ let ec = this.exit_code;
+
+ // Only override when ResExitCode has been modified
+ if ec != 0 {
+ ProgramControlUnit::OverrideExitCode(this.exit_code).into()
+ } else {
+ ProgramControls::Empty
+ }
}));
}
}
diff --git a/mingling/src/setups/picker.rs b/mingling/src/setups/picker.rs
new file mode 100644
index 0000000..3c0d1c8
--- /dev/null
+++ b/mingling/src/setups/picker.rs
@@ -0,0 +1,10 @@
+mod basic;
+pub use basic::*;
+
+#[cfg(feature = "structural_renderer")]
+mod structural_renderer;
+#[cfg(feature = "structural_renderer")]
+pub use structural_renderer::*;
+
+mod consts;
+pub use consts::*;
diff --git a/mingling/src/setups/picker/basic.rs b/mingling/src/setups/picker/basic.rs
new file mode 100644
index 0000000..0539a09
--- /dev/null
+++ b/mingling/src/setups/picker/basic.rs
@@ -0,0 +1,138 @@
+use arg_picker::{IntoPicker, PickerArg, PickerArgs, value::Flag};
+use mingling_core::{Program, ProgramCollect, setup::ProgramSetup};
+
+use crate::setups::picker::{CONFIRM_FLAG, HELP_FLAG, QUIET_FLAG};
+
+/// Helper: picks a boolean flag from the program arguments, calls `f` with the
+/// flag value, then replaces the program arguments with the remaining args.
+fn pick_flag<'a, C>(
+ program: &mut Program<C>,
+ flag: &PickerArg<'a, Flag>,
+ f: impl FnOnce(bool, &mut Program<C>),
+) where
+ C: ProgramCollect<Enum = C>,
+{
+ let args = program.take_args();
+ let remains_arg = PickerArg::<PickerArgs<'a>>::new(&[], None, true);
+ let (active, remains) = args.pick(flag).pick(&remains_arg).unwrap();
+ f(*active, program);
+ program.replace_args(remains.into());
+}
+
+/// Performs basic program initialization:
+///
+/// - Collects `--quiet` flag to control message rendering
+/// - Collects `--help` flag to enable help mode
+/// - Collects `--confirm` flag to skip user confirmation
+pub struct BasicProgramSetup;
+
+impl<C> ProgramSetup<C> for BasicProgramSetup
+where
+ C: ProgramCollect<Enum = C>,
+{
+ fn setup(self, program: &mut Program<C>) {
+ program.with_setup(HelpFlagSetup::default());
+ program.with_setup(QuietFlagSetup::default());
+ program.with_setup(ConfirmFlagSetup::default());
+ }
+}
+
+/// Provides setup for parsing the user help flag
+///
+/// The default value is `--help / -h`
+pub struct HelpFlagSetup<'a> {
+ flag: &'a PickerArg<'a, Flag>,
+}
+
+impl<'a> HelpFlagSetup<'a> {
+ /// Creates a new `HelpFlagSetup` with the given flag aliases.
+ pub fn new(flag: &'a PickerArg<Flag>) -> Self {
+ Self { flag }
+ }
+}
+
+impl<'a, C> ProgramSetup<C> for HelpFlagSetup<'a>
+where
+ C: ProgramCollect<Enum = C>,
+{
+ fn setup(self, program: &mut Program<C>) {
+ pick_flag(program, self.flag, |active, ctx| {
+ ctx.user_context.help = active;
+ });
+ }
+}
+
+impl<'a> Default for HelpFlagSetup<'a> {
+ fn default() -> Self {
+ Self { flag: &HELP_FLAG }
+ }
+}
+
+/// Provides setup for parsing the quiet flag
+///
+/// The default value is `--quiet / -q`
+pub struct QuietFlagSetup<'a> {
+ flag: &'a PickerArg<'a, Flag>,
+}
+
+impl<'a> QuietFlagSetup<'a> {
+ /// Creates a new `QuietFlagSetup` with the given flag aliases.
+ pub fn new(flag: &'a PickerArg<Flag>) -> Self {
+ Self { flag }
+ }
+}
+
+impl<'a, C> ProgramSetup<C> for QuietFlagSetup<'a>
+where
+ C: ProgramCollect<Enum = C>,
+{
+ fn setup(self, program: &mut Program<C>) {
+ pick_flag(program, self.flag, |active, ctx| {
+ if active {
+ ctx.stdout_setting.render_output = false;
+ ctx.stdout_setting.error_output = false;
+ }
+ });
+ }
+}
+
+impl<'a> Default for QuietFlagSetup<'a> {
+ fn default() -> Self {
+ Self { flag: &QUIET_FLAG }
+ }
+}
+
+/// Provides setup for parsing the confirm flag
+///
+/// The default value is `--confirm / -C`
+pub struct ConfirmFlagSetup<'a> {
+ flag: &'a PickerArg<'a, Flag>,
+}
+
+impl<'a> ConfirmFlagSetup<'a> {
+ /// Creates a new `ConfirmFlagSetup` with the given flag aliases.
+ pub fn new(flag: &'a PickerArg<Flag>) -> Self {
+ Self { flag }
+ }
+}
+
+impl<'a, C> ProgramSetup<C> for ConfirmFlagSetup<'a>
+where
+ C: ProgramCollect<Enum = C>,
+{
+ fn setup(self, program: &mut Program<C>) {
+ pick_flag(program, self.flag, |active, ctx| {
+ if active {
+ ctx.user_context.confirm = true;
+ }
+ });
+ }
+}
+
+impl<'a> Default for ConfirmFlagSetup<'a> {
+ fn default() -> Self {
+ Self {
+ flag: &CONFIRM_FLAG,
+ }
+ }
+}
diff --git a/mingling/src/setups/picker/consts.rs b/mingling/src/setups/picker/consts.rs
new file mode 100644
index 0000000..e254b4f
--- /dev/null
+++ b/mingling/src/setups/picker/consts.rs
@@ -0,0 +1,105 @@
+use std::marker::PhantomData;
+
+use arg_picker::{PickerArg, value::Flag};
+
+/// Help flag: display usage information.
+/// - `full`: `["help"]`
+/// - `short`: `'h'`
+pub const HELP_FLAG: PickerArg<Flag> = PickerArg::<Flag> {
+ full: &["help"],
+ short: Some('h'),
+ positional: false,
+ internal_type: PhantomData,
+};
+
+/// Quiet flag: suppress output.
+/// - `full`: `["quiet"]`
+/// - `short`: `'q'`
+pub const QUIET_FLAG: PickerArg<Flag> = PickerArg::<Flag> {
+ full: &["quiet"],
+ short: Some('q'),
+ positional: false,
+ internal_type: PhantomData,
+};
+
+/// Confirm flag: require user confirmation before proceeding.
+/// - `full`: `["confirm"]`
+/// - `short`: `'C'`
+pub const CONFIRM_FLAG: PickerArg<Flag> = PickerArg::<Flag> {
+ full: &["confirm"],
+ short: Some('C'),
+ positional: false,
+ internal_type: PhantomData,
+};
+
+/// JSON flag: enable JSON output format.
+/// - `full`: `["json"]`
+/// - `short`: (none)
+/// Available only when the `json_serde_fmt` feature is enabled.
+#[cfg(feature = "json_serde_fmt")]
+pub const JSON_FLAG: PickerArg<Flag> = PickerArg::<Flag> {
+ full: &["json"],
+ short: None,
+ positional: false,
+ internal_type: PhantomData,
+};
+
+/// JSON pretty flag: enable pretty-printed JSON output format.
+/// - `full`: `["json_pretty"]`
+/// - `short`: (none)
+/// Available only when the `json_serde_fmt` feature is enabled.
+#[cfg(feature = "json_serde_fmt")]
+pub const JSON_PRETTY_FLAG: PickerArg<Flag> = PickerArg::<Flag> {
+ full: &["json_pretty"],
+ short: None,
+ positional: false,
+ internal_type: PhantomData,
+};
+
+/// YAML flag: enable YAML output format.
+/// - `full`: `["yaml"]`
+/// - `short`: (none)
+/// Available only when the `yaml_serde_fmt` feature is enabled.
+#[cfg(feature = "yaml_serde_fmt")]
+pub const YAML_FLAG: PickerArg<Flag> = PickerArg::<Flag> {
+ full: &["yaml"],
+ short: None,
+ positional: false,
+ internal_type: PhantomData,
+};
+
+/// TOML flag: enable TOML output format.
+/// - `full`: `["toml"]`
+/// - `short`: (none)
+/// Available only when the `toml_serde_fmt` feature is enabled.
+#[cfg(feature = "toml_serde_fmt")]
+pub const TOML_FLAG: PickerArg<Flag> = PickerArg::<Flag> {
+ full: &["toml"],
+ short: None,
+ positional: false,
+ internal_type: PhantomData,
+};
+
+/// RON flag: enable RON output format.
+/// - `full`: `["ron"]`
+/// - `short`: (none)
+/// Available only when the `ron_serde_fmt` feature is enabled.
+#[cfg(feature = "ron_serde_fmt")]
+pub const RON_FLAG: PickerArg<Flag> = PickerArg::<Flag> {
+ full: &["ron"],
+ short: None,
+ positional: false,
+ internal_type: PhantomData,
+};
+
+/// RON pretty flag: enable pretty-printed RON output format.
+/// - `full`: `["ron_pretty"]`
+/// - `short`: (none)
+/// Available only when the `ron_serde_fmt` feature is enabled.
+#[cfg(feature = "ron_serde_fmt")]
+pub const RON_PRETTY_FLAG: PickerArg<Flag> = PickerArg::<Flag> {
+ full: &["ron_pretty"],
+ short: None,
+ positional: false,
+ internal_type: PhantomData,
+};
diff --git a/mingling/src/setups/picker/structural_renderer.rs b/mingling/src/setups/picker/structural_renderer.rs
new file mode 100644
index 0000000..69f05f1
--- /dev/null
+++ b/mingling/src/setups/picker/structural_renderer.rs
@@ -0,0 +1,87 @@
+use arg_picker::{IntoPicker, PickerArg, PickerArgs};
+use mingling_core::{Program, ProgramCollect, setup::ProgramSetup};
+
+use crate::setups::picker::{
+ JSON_FLAG, JSON_PRETTY_FLAG, RON_FLAG, RON_PRETTY_FLAG, TOML_FLAG, YAML_FLAG,
+};
+
+/// Sets up the structural renderer for the program:
+///
+/// - Adds a `--renderer` global argument to specify the renderer type
+pub struct StructuralRendererSimpleSetup;
+
+impl<C> ProgramSetup<C> for StructuralRendererSimpleSetup
+where
+ C: ProgramCollect<Enum = C>,
+{
+ fn setup(self, program: &mut Program<C>) {
+ program.global_argument("--renderer", |p, renderer| {
+ p.structural_renderer_name = renderer.into();
+ });
+ }
+}
+
+/// Sets up the structural renderer for the program:
+///
+/// - Adds global flags to specify the renderer type:
+/// * `--json` for JSON output
+/// * `--json-pretty` for pretty-printed JSON output
+/// * `--yaml` for YAML output
+/// * `--toml` for TOML output
+/// * `--ron` for RON output
+/// * `--ron-pretty` for pretty-printed RON output
+pub struct StructuralRendererSetup;
+
+impl<C> ProgramSetup<C> for StructuralRendererSetup
+where
+ C: ProgramCollect<Enum = C>,
+{
+ fn setup(self, program: &mut Program<C>) {
+ let args = program.take_args();
+ let args = process_renderer_flags(args, program);
+ program.replace_args(args);
+ }
+}
+
+fn process_renderer_flags<C>(args: Vec<String>, program: &mut Program<C>) -> Vec<String>
+where
+ C: ProgramCollect<Enum = C>,
+{
+ let remains_arg = PickerArg::<PickerArgs>::new(&[], None, true);
+ let (json, json_pretty, yaml, toml, ron, ron_pretty, remains) = args
+ .pick(&JSON_FLAG)
+ .pick(&JSON_PRETTY_FLAG)
+ .pick(&YAML_FLAG)
+ .pick(&TOML_FLAG)
+ .pick(&RON_FLAG)
+ .pick(&RON_PRETTY_FLAG)
+ .pick(&remains_arg)
+ .unwrap();
+
+ #[cfg(feature = "json_serde_fmt")]
+ if *json {
+ program.structural_renderer_name = crate::StructuralRendererSetting::Json;
+ }
+ #[cfg(feature = "json_serde_fmt")]
+ if *json_pretty {
+ program.structural_renderer_name = crate::StructuralRendererSetting::JsonPretty;
+ }
+ #[cfg(feature = "yaml_serde_fmt")]
+ if *yaml {
+ program.structural_renderer_name = crate::StructuralRendererSetting::Yaml;
+ }
+ #[cfg(feature = "toml_serde_fmt")]
+ if *toml {
+ program.structural_renderer_name = crate::StructuralRendererSetting::Toml;
+ }
+ #[cfg(feature = "ron_serde_fmt")]
+ if *ron {
+ program.structural_renderer_name = crate::StructuralRendererSetting::Ron;
+ }
+ #[cfg(feature = "ron_serde_fmt")]
+ if *ron_pretty {
+ program.structural_renderer_name = crate::StructuralRendererSetting::RonPretty;
+ }
+
+ remains.into()
+}
generated by cgit (git 2.34.1) at 2026-07-17 22:28:15 +0000