1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154
//! Structures that implement different methods on [`Parser`] trait
use crate::{
args::State,
buffer::MetaInfo,
error::{Message, MissingItem},
Doc, Error, Meta, Parser,
};
use std::marker::PhantomData;
/// Parser that substitutes missing value with a function results but not parser
/// failure, created with [`fallback_with`](Parser::fallback_with).
pub struct ParseFallbackWith<T, P, F, E> {
pub(crate) inner: P,
pub(crate) inner_res: PhantomData<T>,
pub(crate) fallback: F,
pub(crate) value_str: String,
pub(crate) err: PhantomData<E>,
}
impl<T, P, F, E> Parser<T> for ParseFallbackWith<T, P, F, E>
where
P: Parser<T>,
F: Fn() -> Result<T, E>,
E: ToString,
{
fn eval(&self, args: &mut State) -> Result<T, Error> {
let mut clone = args.clone();
match self.inner.eval(&mut clone) {
Ok(ok) => {
std::mem::swap(args, &mut clone);
Ok(ok)
}
Err(Error(e)) => {
#[cfg(feature = "autocomplete")]
args.swap_comps(&mut clone);
if e.can_catch() {
match (self.fallback)() {
Ok(ok) => Ok(ok),
Err(e) => Err(Error(Message::PureFailed(e.to_string()))),
}
} else {
Err(Error(e))
}
}
}
}
fn meta(&self) -> Meta {
let m = Meta::Optional(Box::new(self.inner.meta()));
if self.value_str.is_empty() {
m
} else {
let buf = Doc::from(self.value_str.as_str());
Meta::Suffix(Box::new(m), Box::new(buf))
}
}
}
/// Parser with attached message to several fields, created with [`group_help`](Parser::group_help).
pub struct ParseGroupHelp<P> {
pub(crate) inner: P,
pub(crate) message: Doc,
}
impl<T, P> Parser<T> for ParseGroupHelp<P>
where
P: Parser<T>,
{
fn eval(&self, args: &mut State) -> Result<T, Error> {
#[cfg(feature = "autocomplete")]
let mut comp_items = Vec::new();
#[cfg(feature = "autocomplete")]
args.swap_comps_with(&mut comp_items);
#[allow(clippy::let_and_return)]
let res = self.inner.eval(args);
#[cfg(feature = "autocomplete")]
args.swap_comps_with(&mut comp_items);
#[cfg(feature = "autocomplete")]
args.push_with_group(&self.message.to_completion(), &mut comp_items);
res
}
fn meta(&self) -> Meta {
let meta = Box::new(self.inner.meta());
Meta::Subsection(meta, Box::new(self.message.clone()))
}
}
/// Parser with attached message to several fields, created with [`group_help`](Parser::group_help).
pub struct ParseWithGroupHelp<P, F> {
pub(crate) inner: P,
pub(crate) f: F,
}
impl<T, P, F> Parser<T> for ParseWithGroupHelp<P, F>
where
P: Parser<T>,
F: Fn(MetaInfo) -> Doc,
{
fn eval(&self, args: &mut State) -> Result<T, Error> {
self.inner.eval(args)
}
fn meta(&self) -> Meta {
let meta = self.inner.meta();
let buf = (self.f)(MetaInfo(&meta));
Meta::Subsection(Box::new(meta), Box::new(buf))
}
}
/// Apply inner parser several times and collect results into `Vec`, created with
/// [`some`](Parser::some), requires for at least one item to be available to succeed.
/// Implements [`catch`](ParseMany::catch)
pub struct ParseSome<P> {
pub(crate) inner: P,
pub(crate) message: &'static str,
pub(crate) catch: bool,
}
impl<P> ParseSome<P> {
#[must_use]
/// Handle parse failures
///
/// Can be useful to decide to skip parsing of some items on a command line
/// When parser succeeds - `catch` version would return a value as usual
/// if it fails - `catch` would restore all the consumed values and return None.
///
/// There's several structures that implement this attribute: [`ParseOptional`], [`ParseMany`]
/// and [`ParseSome`], behavior should be identical for all of them.
#[cfg_attr(not(doctest), doc = include_str!("docs2/some_catch.md"))]
pub fn catch(mut self) -> Self {
self.catch = true;
self
}
}
impl<T, P> Parser<Vec<T>> for ParseSome<P>
where
P: Parser<T>,
{
fn eval(&self, args: &mut State) -> Result<Vec<T>, Error> {
let mut res = Vec::new();
let mut len = usize::MAX;
while let Some(val) = parse_option(&self.inner, &mut len, args, self.catch)? {
res.push(val);
}
if res.is_empty() {
Err(Error(Message::ParseSome(self.message)))
} else {
Ok(res)
}
}
fn meta(&self) -> Meta {
Meta::Many(Box::new(Meta::Required(Box::new(self.inner.meta()))))
}
}
/// Apply inner parser several times and collect results into `FromIterator`, created with
/// [`collect`](Parser::collect),
/// Implements [`catch`](ParseCollect::catch)
pub struct ParseCollect<P, C, T> {
pub(crate) inner: P,
pub(crate) catch: bool,
pub(crate) ctx: PhantomData<(C, T)>,
}
impl<T, C, P> ParseCollect<P, C, T> {
#[must_use]
/// Handle parse failures
///
/// Can be useful to decide to skip parsing of some items on a command line
/// When parser succeeds - `catch` version would return a value as usual
/// if it fails - `catch` would restore all the consumed values and return None.
///
/// There's several structures that implement this attribute: [`ParseOptional`], [`ParseMany`]
/// and [`ParseSome`], behavior should be identical for all of them.
#[cfg_attr(not(doctest), doc = include_str!("docs2/some_catch.md"))]
pub fn catch(mut self) -> Self {
self.catch = true;
self
}
}
impl<T, C, P> Parser<C> for ParseCollect<P, C, T>
where
P: Parser<T>,
C: FromIterator<T>,
{
fn eval(&self, args: &mut State) -> Result<C, Error> {
let mut len = usize::MAX;
std::iter::from_fn(|| parse_option(&self.inner, &mut len, args, self.catch).transpose())
.collect::<Result<C, Error>>()
}
fn meta(&self) -> Meta {
Meta::Many(Box::new(Meta::Required(Box::new(self.inner.meta()))))
}
}
/// Parser that returns results as usual but not shown in `--help` output, created with
/// [`Parser::hide`]
pub struct ParseHide<P> {
pub(crate) inner: P,
}
impl<T, P> Parser<T> for ParseHide<P>
where
P: Parser<T>,
{
fn eval(&self, args: &mut State) -> Result<T, Error> {
#[cfg(feature = "autocomplete")]
let mut comps = Vec::new();
#[cfg(feature = "autocomplete")]
args.swap_comps_with(&mut comps);
#[allow(clippy::let_and_return)]
let res = self.inner.eval(args);
#[cfg(feature = "autocomplete")]
args.swap_comps_with(&mut comps);
if let Err(Error(Message::Missing(_))) = res {
Err(Error(Message::Missing(Vec::new())))
} else {
res
}
}
fn meta(&self) -> Meta {
Meta::Skip
}
}
/// Parser that hides inner parser from usage line
///
/// No other changes to the inner parser
pub struct ParseUsage<P> {
pub(crate) inner: P,
pub(crate) usage: Doc,
}
impl<T, P> Parser<T> for ParseUsage<P>
where
P: Parser<T>,
{
fn eval(&self, args: &mut State) -> Result<T, Error> {
self.inner.eval(args)
}
fn meta(&self) -> Meta {
Meta::CustomUsage(Box::new(self.inner.meta()), Box::new(self.usage.clone()))
}
}
/// Parser that tries to either of two parsers and uses one that succeeeds, created with
/// [`Parser::or_else`].
pub struct ParseOrElse<T> {
pub(crate) this: Box<dyn Parser<T>>,
pub(crate) that: Box<dyn Parser<T>>,
}
impl<T> Parser<T> for ParseOrElse<T> {
fn eval(&self, args: &mut State) -> Result<T, Error> {
#[cfg(feature = "autocomplete")]
let mut comp_items = Vec::new();
#[cfg(feature = "autocomplete")]
args.swap_comps_with(&mut comp_items);
// create forks for both branches
// if they both fail - fallback to the original arguments
// if they both succed - pick the one that consumes left, remember the second one
// if one succeeds - pick that, forget the remaining one unless we are doing completion
let mut args_a = args.clone();
let mut args_b = args.clone();
// run both parsers, expand Result<T, Error> into Option<T> + Option<Error>
// so that code that does a bunch of comparing logic can be shared across
// all invocations of parsers rather than being inlined into each one.
let (res_a, err_a) = match self.this.eval(&mut args_a) {
Ok(ok) => (Some(ok), None),
Err(err) => (None, Some(err)),
};
let (res_b, err_b) = match self.that.eval(&mut args_b) {
Ok(ok) => (Some(ok), None),
Err(err) => (None, Some(err)),
};
if this_or_that_picks_first(
err_a,
err_b,
args,
&mut args_a,
&mut args_b,
#[cfg(feature = "autocomplete")]
comp_items,
)? {
Ok(res_a.unwrap())
} else {
Ok(res_b.unwrap())
}
}
fn meta(&self) -> Meta {
self.this.meta().or(self.that.meta())
}
}
/// Given two possible errors along with to sets of arguments produce a new error or an instruction
/// to pick between two answers. Updates arguments state to match the results
fn this_or_that_picks_first(
err_a: Option<Error>,
err_b: Option<Error>,
args: &mut State,
args_a: &mut State,
args_b: &mut State,
#[cfg(feature = "autocomplete")] mut comp_stash: Vec<crate::complete_gen::Comp>,
) -> Result<bool, Error> {
// if higher depth parser succeeds - it takes a priority
// completion from different depths should never mix either
match Ord::cmp(&args_a.depth(), &args_b.depth()) {
std::cmp::Ordering::Less => {
std::mem::swap(args, args_b);
#[cfg(feature = "autocomplete")]
if let Some(comp) = args.comp_mut() {
comp.extend_comps(comp_stash);
}
return match err_b {
Some(err) => Err(err),
None => Ok(false),
};
}
std::cmp::Ordering::Equal => {}
std::cmp::Ordering::Greater => {
std::mem::swap(args, args_a);
#[cfg(feature = "autocomplete")]
if let Some(comp) = args.comp_mut() {
comp.extend_comps(comp_stash);
}
return match err_a {
Some(err) => Err(err),
None => Ok(true),
};
}
}
// otherwise pick based on the left most or successful one
#[allow(clippy::let_and_return)] // <- it is without autocomplete only
let res = match (err_a, err_b) {
(None, None) => {
if args.len() == args_a.len() && args.len() == args_b.len() {
Ok((true, None))
} else {
Ok(args_a.pick_winner(args_b))
}
}
(Some(e1), Some(e2)) => Err(e1.combine_with(e2)),
// otherwise either a or b are success, true means a is success
(a_ok, _) => Ok((a_ok.is_none(), None)),
};
#[cfg(feature = "autocomplete")]
let len_a = args_a.len();
#[cfg(feature = "autocomplete")]
let len_b = args_b.len();
#[cfg(feature = "autocomplete")]
if let (Some(a), Some(b)) = (args_a.comp_mut(), args_b.comp_mut()) {
// if both parsers managed to consume the same amount - including 0, keep
// results from both, otherwise keep results from one that consumed more
let (keep_a, keep_b) = match res {
Ok((true, _)) => (true, false),
Ok((false, _)) => (false, true),
Err(_) => match len_a.cmp(&len_b) {
std::cmp::Ordering::Less => (true, false),
std::cmp::Ordering::Equal => (true, true),
std::cmp::Ordering::Greater => (false, true),
},
};
if keep_a {
comp_stash.extend(a.drain_comps());
}
if keep_b {
comp_stash.extend(b.drain_comps());
}
}
match res {
Ok((true, ix)) => {
if let Some(win) = ix {
args_a.save_conflicts(args_b, win);
}
std::mem::swap(args, args_a);
}
Ok((false, ix)) => {
if let Some(win) = ix {
args_b.save_conflicts(args_a, win);
}
std::mem::swap(args, args_b);
}
// no winner, keep the completions but don't touch args otherwise
Err(_) => {}
}
#[cfg(feature = "autocomplete")]
if let Some(comp) = args.comp_mut() {
comp.extend_comps(comp_stash);
}
Ok(res?.0)
}
/// Parser that transforms parsed value with a failing function, created with
/// [`parse`](Parser::parse)
pub struct ParseWith<T, P, F, E, R> {
pub(crate) inner: P,
pub(crate) inner_res: PhantomData<T>,
pub(crate) parse_fn: F,
pub(crate) res: PhantomData<R>,
pub(crate) err: PhantomData<E>,
}
impl<T, P, F, E, R> Parser<R> for ParseWith<T, P, F, E, R>
where
P: Parser<T>,
F: Fn(T) -> Result<R, E>,
E: ToString,
{
fn eval(&self, args: &mut State) -> Result<R, Error> {
let t = self.inner.eval(args)?;
match (self.parse_fn)(t) {
Ok(r) => Ok(r),
Err(e) => Err(Error(Message::ParseFailed(args.current, e.to_string()))),
}
}
fn meta(&self) -> Meta {
self.inner.meta()
}
}
/// Parser that substitutes missing value but not parse failure, created with
/// [`fallback`](Parser::fallback).
pub struct ParseFallback<P, T> {
pub(crate) inner: P,
pub(crate) value: T,
pub(crate) value_str: String,
}
impl<P, T> Parser<T> for ParseFallback<P, T>
where
P: Parser<T>,
T: Clone,
{
fn eval(&self, args: &mut State) -> Result<T, Error> {
let mut clone = args.clone();
match self.inner.eval(&mut clone) {
Ok(ok) => {
std::mem::swap(args, &mut clone);
Ok(ok)
}
Err(Error(e)) => {
#[cfg(feature = "autocomplete")]
args.swap_comps(&mut clone);
if e.can_catch() {
Ok(self.value.clone())
} else {
Err(Error(e))
}
}
}
}
fn meta(&self) -> Meta {
let m = Meta::Optional(Box::new(self.inner.meta()));
if self.value_str.is_empty() {
m
} else {
let buf = Doc::from(self.value_str.as_str());
Meta::Suffix(Box::new(m), Box::new(buf))
}
}
}
impl<P, T: std::fmt::Display> ParseFallback<P, T> {
/// Show [`fallback`](Parser::fallback) value in `--help` using [`Display`](std::fmt::Display)
/// representation
///
#[cfg_attr(not(doctest), doc = include_str!("docs2/dis_fallback.md"))]
#[must_use]
pub fn display_fallback(mut self) -> Self {
self.value_str = format!("[default: {}]", self.value);
self
}
}
impl<P, T: std::fmt::Debug> ParseFallback<P, T> {
/// Show [`fallback`](Parser::fallback) value in `--help` using [`Debug`](std::fmt::Debug)
/// representation
///
#[cfg_attr(not(doctest), doc = include_str!("docs2/deb_fallback_with.md"))]
#[must_use]
pub fn debug_fallback(mut self) -> Self {
self.value_str = format!("[default: {:?}]", self.value);
self
}
}
impl<P, T: std::fmt::Display, F, E> ParseFallbackWith<T, P, F, E>
where
F: Fn() -> Result<T, E>,
{
/// Show [`fallback_with`](Parser::fallback_with) value in `--help` using [`Display`](std::fmt::Display)
/// representation
///
/// If fallback function fails - no value will show up
///
#[cfg_attr(not(doctest), doc = include_str!("docs2/dis_fallback_with.md"))]
#[must_use]
pub fn display_fallback(mut self) -> Self {
if let Ok(val) = (self.fallback)() {
self.value_str = format!("[default: {}]", val);
}
self
}
}
impl<P, T: std::fmt::Debug, F, E> ParseFallbackWith<T, P, F, E>
where
F: Fn() -> Result<T, E>,
{
/// Show [`fallback_with`](Parser::fallback_with) value in `--help` using [`Debug`](std::fmt::Debug)
/// representation
///
/// If fallback function fails - no value will show up
///
#[cfg_attr(not(doctest), doc = include_str!("docs2/deb_fallback.md"))]
#[must_use]
pub fn debug_fallback(mut self) -> Self {
if let Ok(val) = (self.fallback)() {
self.value_str = format!("[default: {:?}]", val);
}
self
}
}
/// Parser fails with a message if check returns false, created with [`guard`](Parser::guard).
pub struct ParseGuard<P, F> {
pub(crate) inner: P,
pub(crate) check: F,
pub(crate) message: &'static str,
}
impl<T, P, F> Parser<T> for ParseGuard<P, F>
where
P: Parser<T>,
F: Fn(&T) -> bool,
{
fn eval(&self, args: &mut State) -> Result<T, Error> {
let t = self.inner.eval(args)?;
if (self.check)(&t) {
Ok(t)
} else {
Err(Error(Message::GuardFailed(args.current, self.message)))
}
}
fn meta(&self) -> Meta {
self.inner.meta()
}
}
/// Apply inner parser as many times as it succeeds while consuming something and return this
/// number
pub struct ParseCount<P, T> {
pub(crate) inner: P,
pub(crate) ctx: PhantomData<T>,
}
impl<T, P> Parser<usize> for ParseCount<P, T>
where
P: Parser<T>,
{
fn eval(&self, args: &mut State) -> Result<usize, Error> {
let mut res = 0;
let mut current = args.len();
let mut len = usize::MAX;
while (parse_option(&self.inner, &mut len, args, false)?).is_some() {
res += 1;
if current == args.len() {
break;
}
current = args.len();
}
Ok(res)
}
fn meta(&self) -> Meta {
Meta::Many(Box::new(Meta::Optional(Box::new(self.inner.meta()))))
}
}
/// Apply inner parser as many times as it succeeds while consuming something and return this
/// number
pub struct ParseLast<P> {
pub(crate) inner: P,
}
impl<T, P> Parser<T> for ParseLast<P>
where
P: Parser<T>,
{
fn eval(&self, args: &mut State) -> Result<T, Error> {
let mut last = None;
let mut current = args.len();
let mut len = usize::MAX;
while let Some(val) = parse_option(&self.inner, &mut len, args, false)? {
last = Some(val);
if current == args.len() {
break;
}
current = args.len();
}
if let Some(last) = last {
Ok(last)
} else {
self.inner.eval(args)
}
}
fn meta(&self) -> Meta {
Meta::Many(Box::new(Meta::Required(Box::new(self.inner.meta()))))
}
}
/// Apply inner parser, return a value in `Some` if items requested by it are all present, restore
/// and return `None` if any are missing. Created with [`optional`](Parser::optional). Implements
/// [`catch`](ParseOptional::catch)
pub struct ParseOptional<P> {
pub(crate) inner: P,
pub(crate) catch: bool,
}
impl<T, P> Parser<Option<T>> for ParseOptional<P>
where
P: Parser<T>,
{
fn eval(&self, args: &mut State) -> Result<Option<T>, Error> {
let mut len = usize::MAX;
parse_option(&self.inner, &mut len, args, self.catch)
}
fn meta(&self) -> Meta {
Meta::Optional(Box::new(self.inner.meta()))
}
}
impl<P> ParseOptional<P> {
#[must_use]
/// Handle parse failures for optional parsers
///
/// Can be useful to decide to skip parsing of some items on a command line.
/// When parser succeeds - `catch` version would return a value as usual
/// if it fails - `catch` would restore all the consumed values and return None.
///
/// There's several structures that implement this attribute: [`ParseOptional`], [`ParseMany`]
/// and [`ParseSome`], behavior should be identical for all of them.
///
/// Those examples are very artificial and designed to show what difference `catch` makes, to
/// actually parse arguments like in examples you should [`parse`](Parser::parse) or construct
/// enum with alternative branches
#[cfg_attr(not(doctest), doc = include_str!("docs2/optional_catch.md"))]
pub fn catch(mut self) -> Self {
self.catch = true;
self
}
}
/// Apply inner parser several times and collect results into `Vec`, created with
/// [`many`](Parser::many), implements [`catch`](ParseMany::catch).
pub struct ParseMany<P> {
pub(crate) inner: P,
pub(crate) catch: bool,
}
impl<P> ParseMany<P> {
#[must_use]
/// Handle parse failures
///
/// Can be useful to decide to skip parsing of some items on a command line
/// When parser succeeds - `catch` version would return a value as usual
/// if it fails - `catch` would restore all the consumed values and return None.
///
/// There's several structures that implement this attribute: [`ParseOptional`], [`ParseMany`]
/// and [`ParseSome`], behavior should be identical for all of them.
#[cfg_attr(not(doctest), doc = include_str!("docs2/many_catch.md"))]
pub fn catch(mut self) -> Self {
self.catch = true;
self
}
}
/// try to parse
fn parse_option<P, T>(
parser: &P,
len: &mut usize,
args: &mut State,
catch: bool,
) -> Result<Option<T>, Error>
where
P: Parser<T>,
{
let mut orig_args = args.clone();
match parser.eval(args) {
// we keep including values for as long as we consume values from the argument
// list or at least one value
Ok(val) => Ok(if args.len() < *len {
*len = args.len();
Some(val)
} else {
None
}),
Err(Error(err)) => {
// this is safe to return Ok(None) in following scenarios
// when inner parser never consumed anything and
// 1. produced Error::Missing
// 2. produced Error::Message(_, true)
// 3. produced Error::Message and catch is enabled
//
// In all other scenarios we should return the original error
//
// When parser returns Ok(None) we should return the original arguments so if there's
// anything left unconsumed - this won't be lost.
let missing = matches!(err, Message::Missing(_));
if catch || (missing && orig_args.len() == args.len()) || (!missing && err.can_catch())
{
std::mem::swap(&mut orig_args, args);
#[cfg(feature = "autocomplete")]
if orig_args.comp_mut().is_some() {
args.swap_comps(&mut orig_args);
}
Ok(None)
} else {
Err(Error(err))
}
}
}
}
impl<T, P> Parser<Vec<T>> for ParseMany<P>
where
P: Parser<T>,
{
fn eval(&self, args: &mut State) -> Result<Vec<T>, Error> {
let mut len = usize::MAX;
std::iter::from_fn(|| parse_option(&self.inner, &mut len, args, self.catch).transpose())
.collect::<Result<Vec<T>, Error>>()
}
fn meta(&self) -> Meta {
Meta::Many(Box::new(Meta::Optional(Box::new(self.inner.meta()))))
}
}
/// Parser that returns a given value without consuming anything, created with
/// [`pure`](crate::pure).
pub struct ParsePure<T>(pub(crate) T);
impl<T: Clone + 'static> Parser<T> for ParsePure<T> {
fn eval(&self, args: &mut State) -> Result<T, Error> {
args.current = None;
Ok(self.0.clone())
}
fn meta(&self) -> Meta {
Meta::Skip
}
}
pub struct ParsePureWith<T, F, E>(pub(crate) F)
where
F: Fn() -> Result<T, E>,
E: ToString;
impl<T: Clone + 'static, F: Fn() -> Result<T, E>, E: ToString> Parser<T>
for ParsePureWith<T, F, E>
{
fn eval(&self, _args: &mut State) -> Result<T, Error> {
match (self.0)() {
Ok(ok) => Ok(ok),
Err(e) => Err(Error(Message::PureFailed(e.to_string()))),
}
}
fn meta(&self) -> Meta {
Meta::Skip
}
}
/// Parser that fails without consuming any input, created with [`fail`](crate::fail).
pub struct ParseFail<T> {
pub(crate) field1: &'static str,
pub(crate) field2: PhantomData<T>,
}
impl<T> Parser<T> for ParseFail<T> {
fn eval(&self, args: &mut State) -> Result<T, Error> {
args.current = None;
Err(Error(Message::ParseFail(self.field1)))
}
fn meta(&self) -> Meta {
Meta::Skip
}
}
/// Parser that transforms parsed value with a function, created with [`map`](Parser::map).
pub struct ParseMap<T, P, F, R> {
pub(crate) inner: P,
pub(crate) inner_res: PhantomData<T>,
pub(crate) map_fn: F,
pub(crate) res: PhantomData<R>,
}
impl<P, T, F, R> Parser<R> for ParseMap<T, P, F, R>
where
F: Fn(T) -> R,
P: Parser<T> + Sized,
{
fn eval(&self, args: &mut State) -> Result<R, Error> {
let t = self.inner.eval(args)?;
Ok((self.map_fn)(t))
}
fn meta(&self) -> Meta {
self.inner.meta()
}
}
/// Create parser from a function, [`construct!`](crate::construct!) uses it internally
pub struct ParseCon<P> {
/// inner parser closure
pub inner: P,
/// metas for inner parsers
pub meta: Meta,
/// To produce a better error messages while parsing constructed values
/// we want to look at all the items so values that can be consumed are consumed
/// autocomplete relies on the same logic
///
/// However when dealing with adjacent restriction detecting the first item relies on failing
/// fast
pub failfast: bool,
}
impl<T, P> Parser<T> for ParseCon<P>
where
P: Fn(bool, &mut State) -> Result<T, Error>,
{
fn eval(&self, args: &mut State) -> Result<T, Error> {
let res = (self.inner)(self.failfast, args);
args.current = None;
res
}
fn meta(&self) -> Meta {
self.meta.clone()
}
}
impl<T> ParseCon<T> {
#[must_use]
/// Automagically restrict the inner parser scope to accept adjacent values only
///
/// `adjacent` can solve surprisingly wide variety of problems: sequential command chaining,
/// multi-value arguments, option-structs to name a few. If you want to run a parser on a
/// sequential subset of arguments - `adjacent` might be able to help you. Check the examples
/// for better intuition.
///
/// Let's consider two examples with consumed items marked in bold and constructor containing
/// parsers for `-c` and `-d`.
///
/// - <code>**-a** -b **-c** -d</code>
/// - <code>**-a** **-c** -b -d</code>
///
/// In the first example `-b` breaks the adjacency for all the consumed items so parsing will fail,
/// while here in the second one all the consumed items are adjacent to each other so
/// parsing will succeed.
///
/// # Multi-value arguments
///
/// Parsing things like `--point X Y Z`
#[cfg_attr(not(doctest), doc = include_str!("docs2/adjacent_struct_0.md"))]
///
/// # Structure groups
///
/// Parsing things like `--rect --width W --height H --rect --height H --width W`
#[cfg_attr(not(doctest), doc = include_str!("docs2/adjacent_struct_1.md"))]
///
/// # Chaining commands
/// This example explains [`adjacent`](crate::params::ParseCommand::adjacent), but the same idea holds.
/// Parsing things like `cmd1 --arg1 cmd2 --arg2 --arg3 cmd3 --flag`
///
#[cfg_attr(not(doctest), doc = include_str!("docs2/adjacent_command.md"))]
///
/// # Capturing everything between markers
///
/// Parsing things like `find . --exec foo {} -bar ; --more`
///
#[cfg_attr(not(doctest), doc = include_str!("docs2/adjacent_struct_3.md"))]
///
/// # Multi-value arguments with optional flags
///
/// Parsing things like `--foo ARG1 --flag --inner ARG2`
///
/// So you can parse things while parsing things. Not sure why you might need this, but you can
/// :)
///
#[cfg_attr(not(doctest), doc = include_str!("docs2/adjacent_struct_4.md"))]
///
/// # Performance and other considerations
///
/// `bpaf` can run adjacently restricted parsers multiple times to refine the guesses. It's
/// best not to have complex inter-fields verification since they might trip up the detection
/// logic: instead of restricting, for example "sum of two fields to be 5 or greater" *inside* the
/// `adjacent` parser, you can restrict it *outside*, once `adjacent` done the parsing.
///
/// There's also similar method [`adjacent`](crate::parsers::ParseArgument) that allows to restrict argument
/// parser to work only for arguments where both key and a value are in the same shell word:
/// `-f=bar` or `-fbar`, but not `-f bar`.
pub fn adjacent(mut self) -> ParseAdjacent<Self> {
self.failfast = true;
ParseAdjacent { inner: self }
}
}
/// Parser that replaces metavar placeholders with actual info in shell completion
#[cfg(feature = "autocomplete")]
pub struct ParseComp<P, F> {
pub(crate) inner: P,
pub(crate) op: F,
pub(crate) group: Option<String>,
}
#[cfg(feature = "autocomplete")]
impl<P, F> ParseComp<P, F> {
#[must_use]
/// Attach group name to parsed values
pub fn group(mut self, group: impl Into<String>) -> Self {
self.group = Some(group.into());
self
}
}
#[cfg(feature = "autocomplete")]
impl<P, T, F, M> Parser<T> for ParseComp<P, F>
where
P: Parser<T> + Sized,
M: Into<String>,
F: Fn(&T) -> Vec<(M, Option<M>)>,
{
fn eval(&self, args: &mut State) -> Result<T, Error> {
// stash old
let mut comp_items = Vec::new();
args.swap_comps_with(&mut comp_items);
let res = self.inner.eval(args);
// restore old, now metavars added by inner parser, if any, are in comp_items
args.swap_comps_with(&mut comp_items);
if let Some(comp) = &mut args.comp_mut() {
if res.is_err() {
comp.extend_comps(comp_items);
return res;
}
}
let res = res?;
// completion function generates suggestions based on the parsed inner value, for
// that `res` must contain a parsed value
let depth = args.depth();
if let Some(comp) = &mut args.comp_mut() {
for ci in comp_items {
let is_meta = ci.is_metavar();
if let Some(is_arg) = is_meta {
let suggestions = (self.op)(&res);
// strip metavar when completion makes a single good suggestion
if suggestions.len() != 1 {
comp.push_comp(ci);
}
for (replacement, description) in suggestions {
let group = self.group.clone();
comp.push_value(
replacement.into(),
description.map(Into::into),
group,
depth,
is_arg,
);
}
} else {
comp.push_comp(ci);
}
}
}
Ok(res)
}
fn meta(&self) -> Meta {
self.inner.meta()
}
}
/*
#[cfg(feature = "autocomplete")]
pub struct ParseCompStyle<P> {
pub(crate) inner: P,
pub(crate) style: CompleteDecor,
}
#[cfg(feature = "autocomplete")]
impl<P, T> Parser<T> for ParseCompStyle<P>
where
P: Parser<T> + Sized,
{
fn eval(&self, args: &mut State) -> Result<T, Error> {
let mut comp_items = Vec::new();
args.swap_comps_with(&mut comp_items);
let res = self.inner.eval(args);
args.swap_comps_with(&mut comp_items);
args.extend_with_style(self.style, &mut comp_items);
res
}
fn meta(&self) -> Meta {
self.inner.meta()
}
}*/
pub struct ParseAdjacent<P> {
pub(crate) inner: P,
}
impl<P, T> Parser<T> for ParseAdjacent<P>
where
P: Parser<T> + Sized,
{
fn eval(&self, args: &mut State) -> Result<T, Error> {
let original_scope = args.scope();
let first_item;
let inner_meta = self.inner.meta();
let mut best_error = if let Some(item) = Meta::first_item(&inner_meta) {
first_item = item;
let missing_item = MissingItem {
item: item.clone(),
position: original_scope.start,
scope: original_scope.clone(),
};
Message::Missing(vec![missing_item])
} else {
unreachable!("bpaf usage BUG: adjacent should start with a required argument");
};
let mut best_args = args.clone();
let mut best_consumed = 0;
for (start, width, mut this_arg) in args.ranges(first_item) {
// since we only want to parse things to the right of the first item we perform
// parsing in two passes:
// - try to run the parser showing only single argument available at all the indices
// - try to run the parser showing starting at that argument and to the right of it
// this means constructing argument parsers from req flag and positional works as
// expected:
// consider examples "42 -n" and "-n 42"
// without multi step approach first command line also parses into 42
let mut scratch = this_arg.clone();
scratch.set_scope(start..start + width);
let before = scratch.len();
// nothing to consume, might as well skip this segment right now
// it will most likely fail, but it doesn't matter, we are only looking for the
// left most match
if before == 0 {
continue;
}
let _ = self.inner.eval(&mut scratch);
if before == scratch.len() {
// failed to consume anything which means we don't start parsing at this point
continue;
}
this_arg.set_scope(start..original_scope.end);
let before = this_arg.len();
// values consumed by adjacent must be actually adjacent - if a scope contains
// already parsed values inside we need to trim it
if original_scope.end - start > before {
this_arg.set_scope(this_arg.adjacently_available_from(start));
}
loop {
match self.inner.eval(&mut this_arg) {
Ok(res) => {
// there's a smaller adjacent scope, we must try it before returning.
if let Some(adj_scope) = this_arg.adjacent_scope(args) {
this_arg = args.clone();
this_arg.set_scope(adj_scope);
} else {
std::mem::swap(args, &mut this_arg);
args.set_scope(original_scope);
return Ok(res);
}
}
Err(Error(err)) => {
let consumed = before - this_arg.len();
if consumed > best_consumed {
best_consumed = consumed;
std::mem::swap(&mut best_args, &mut this_arg);
best_error = err;
}
break;
}
}
}
}
std::mem::swap(args, &mut best_args);
Err(Error(best_error))
}
fn meta(&self) -> Meta {
let meta = self.inner.meta();
Meta::Adjacent(Box::new(meta))
}
}
impl<T> Parser<T> for Box<dyn Parser<T>> {
fn eval(&self, args: &mut State) -> Result<T, Error> {
self.as_ref().eval(args)
}
fn meta(&self) -> Meta {
self.as_ref().meta()
}
}