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
/*!
Parse Rust's attribute arguments by defining a struct.
See [`#[derive(StructMeta)]`](macro@StructMeta) documentation for details.
*/
#[doc(hidden)]
pub mod helpers;
// mod easy_syntax;
// pub use easy_syntax::*;
mod arg_types;
pub use arg_types::*;
// #[include_doc("../../doc/to_tokens.md", start)]
/// Derive [`quote::ToTokens`] for syntax tree node.
///
/// - [Example](#example)
/// - [Helper attributes](#helper-attributes)
/// - [`#[to_tokens("[", "]", "(", ")", "{", "}"]`](#to_tokens-----)
/// - [`#[to_tokens(dump)]`](#to_tokensdump)
///
/// # Example
///
/// `#[derive(ToTokens)]` generates an implementation of `ToTokens` that calls [`ToTokens::to_tokens`](quote::ToTokens::to_tokens) for each field.
///
/// ```rust
/// use syn::LitInt;
///
/// #[derive(structmeta::ToTokens)]
/// struct Example(LitInt, LitInt);
/// ```
///
/// Code like this will be generated:
///
/// ```rust
/// # use syn::LitInt;
/// # struct Example(LitInt, LitInt);
/// impl quote::ToTokens for Example {
/// fn to_tokens(&self, tokens: &mut proc_macro2::TokenStream) {
/// self.0.to_tokens(tokens);
/// self.1.to_tokens(tokens);
/// }
/// }
/// ```
///
/// `#[derive(ToTokens)]` can also be specified for enum.
///
/// ```rust
/// use syn::{LitInt, LitStr};
///
/// #[derive(structmeta::ToTokens)]
/// enum Example {
/// A(LitInt),
/// B(LitStr),
/// }
/// ```
///
/// Code like this will be generated:
///
/// ```rust
/// # use syn::{LitInt, LitStr};
/// # enum Example {
/// # A(LitInt),
/// # B(LitStr),
/// # }
/// impl quote::ToTokens for Example {
/// fn to_tokens(&self, tokens: &mut proc_macro2::TokenStream) {
/// match self {
/// Self::A(l) => l.to_tokens(tokens),
/// Self::B(l) => l.to_tokens(tokens),
/// }
/// }
/// }
/// ```
///
/// # Helper attributes
///
/// | | struct | enum | variant | field |
/// | ----------------------------------------------------------- | ------ | ---- | ------- | ----- |
/// | [`#[to_tokens("[")]`, `#[to_tokens("]")]`](#to_tokens-----) | | | | ✔ |
/// | [`#[to_tokens("(")]`, `#[to_tokens(")")]`](#to_tokens-----) | | | | ✔ |
/// | [`#[to_tokens("{")]`, `#[to_tokens("}")]`](#to_tokens-----) | | | | ✔ |
/// | [`#[to_tokens(dump)]`](#to_tokensdump) | ✔ | ✔ | | |
///
/// ## `#[to_tokens("[", "]", "(", ")", "{", "}"]`
///
/// By specifying `#[to_tokens("[")]` or `#[to_tokens("(")]` or `#[to_tokens("[")]` , subsequent tokens will be enclosed in `[]` or `()` or `{}`.
///
/// By default, all subsequent fields are enclosed.
/// To restrict the enclosing fields, specify `#[to_tokens("]")]` or `#[to_tokens(")")]` or `#[to_tokens("}")]` for the field after the end of the enclosure.
///
/// ```rust
/// use syn::{token, LitInt};
///
/// #[derive(structmeta::ToTokens)]
/// struct Example {
/// x: LitInt,
/// #[to_tokens("[")]
/// bracket_token: token::Bracket,
/// y: LitInt,
/// #[to_tokens("]")]
/// z: LitInt,
/// }
/// ```
///
/// Code like this will be generated:
///
/// ```rust
/// # use syn::{token, LitInt};
/// #
/// # struct Example {
/// # x: LitInt,
/// # bracket_token: token::Bracket,
/// # y: LitInt,
/// # z: LitInt,
/// # }
/// impl quote::ToTokens for Example {
/// fn to_tokens(&self, tokens: &mut proc_macro2::TokenStream) {
/// self.x.to_tokens(tokens);
/// token::Bracket::surround(&self.bracket_token, tokens, |tokens| {
/// self.y.to_tokens(tokens);
/// });
/// self.z.to_tokens(tokens);
/// }
/// }
/// ```
///
/// If the field type is `Bracket` or `Paren` or `Brace`, the symbol corresponding to the token type must be specified.
///
/// If the field type is `MacroDelimiter`, any symbol can be used and there is no difference in behavior. (Three types of parentheses are available, no matter which symbol is specified.)
///
/// | field type | start | end |
/// | ------------------------------ | ----------------------- | ----------------------- |
/// | [`struct@syn::token::Bracket`] | `"["` | `"]"` |
/// | [`struct@syn::token::Paren`] | `"("` | `")"` |
/// | [`struct@syn::token::Brace`] | `"{"` | `"}"` |
/// | [`enum@syn::MacroDelimiter`] | `"["` or `"("` or `"{"` | `"]"` or `")"` or `"}"` |
///
/// ## `#[to_tokens(dump)]`
///
/// Causes a compile error and outputs the code generated by `#[derive(ToTokens)]` as an error message.
// #[include_doc("../../doc/to_tokens.md", end)]
pub use structmeta_derive::ToTokens;
// #[include_doc("../../doc/parse.md", start)]
/// Derive [`syn::parse::Parse`] for syntax tree node.
///
/// - [Example](#example)
/// - [Helper attributes](#helper-attributes)
/// - [`#[to_tokens("[", "]", "(", ")", "{", "}")]`](#to_tokens-----)
/// - [`#[parse(peek)]`](#parsepeek)
/// - [`#[parse(any)]`](#parseany)
/// - [`#[parse(terminated)]`](#parseterminated)
/// - [`#[parse(dump)]`](#parsedump)
///
/// # Example
///
/// `#[derive(Parse)]` generates an implementation of `Parse` that calls [`Parse::parse`](syn::parse::Parse::parse) for each field.
///
/// ```rust
/// use syn::{LitInt, LitStr};
///
/// #[derive(structmeta::Parse)]
/// struct Example(LitInt, LitStr);
/// ```
///
/// Code like this will be generated:
///
/// ```rust
/// # use syn::{LitInt, LitStr};
/// # struct Example(LitInt, LitStr);
/// impl syn::parse::Parse for Example {
/// fn parse(input: syn::parse::ParseStream) -> syn::Result<Self> {
/// let _0 = input.parse()?;
/// let _1 = input.parse()?;
/// return Ok(Example(_0, _1));
/// }
/// }
/// ```
///
/// `#[derive(Parse)]` can also be specified for enum.
///
/// ```rust
/// use syn::{LitInt, LitStr};
///
/// #[derive(structmeta::Parse)]
/// enum Example {
/// A(LitInt, LitInt),
/// B(LitStr),
/// }
/// ```
///
/// Code like this will be generated:
///
/// ```rust
/// # use syn::{LitInt, LitStr};
/// # enum Example {
/// # A(LitInt, LitInt),
/// # B(LitStr),
/// # }
/// use syn::parse::discouraged::Speculative;
/// impl syn::parse::Parse for Example {
/// fn parse(input: syn::parse::ParseStream) -> syn::Result<Self> {
/// let fork = input.fork();
/// if let Ok(value) = fork.call(|input| Ok(Example::A(input.parse()?, input.parse()?))) {
/// input.advance_to(&fork);
/// return Ok(value);
/// }
///
/// let fork = input.fork();
/// if let Ok(value) = fork.call(|input| Ok(Example::B(input.parse()?))) {
/// input.advance_to(&fork);
/// return Ok(value);
/// }
///
/// Err(input.error("parse failed."))
/// }
/// }
/// ```
///
/// # Helper attributes
///
/// | | struct | enum | variant | field |
/// | --------------------------------------------------------------- | ------ | ---- | ------- | ----- |
/// | [`#[to_tokens("[", "]", "(", ")", "{", "}")]`](#to_tokens-----) | | | | ✔ |
/// | [`#[parse(peek)]`](#parsepeek) | | | | ✔ |
/// | [`#[parse(any)]`](#parseany) | | | | ✔ |
/// | [`#[parse(terminated)]`](#parseterminated) | | | | ✔ |
/// | [`#[parse(dump)]`](#parsedump) | ✔ | ✔ | | |
///
/// ## `#[to_tokens("[", "]", "(", ")", "{", "}")]`
///
/// By specifying `#[to_tokens("[")]` or `#[to_tokens("(")]` or `#[to_tokens("[")]` , subsequent tokens will be enclosed in `[]` or `()` or `{}`.
///
/// By default, all subsequent fields are enclosed.
/// To restrict the enclosing fields, specify `#[to_tokens("]")]` or `#[to_tokens(")")]` or `#[to_tokens("}")]` for the field after the end of the enclosure.
///
/// ```rust
/// use syn::{token, LitInt};
///
/// #[derive(structmeta::Parse)]
/// struct Example {
/// x: LitInt,
/// #[to_tokens("[")]
/// bracket_token: token::Bracket,
/// y: LitInt,
/// #[to_tokens("]")]
/// z: LitInt,
/// }
/// ```
///
/// Code like this will be generated:
///
/// ```rust
/// # use syn::{token, LitInt};
/// #
/// # struct Example {
/// # x: LitInt,
/// # bracket_token: token::Bracket,
/// # y: LitInt,
/// # z: LitInt,
/// # }
/// impl syn::parse::Parse for Example {
/// fn parse(input: syn::parse::ParseStream) -> syn::Result<Self> {
/// let x = input.parse()?;
/// let content;
/// let bracket_token = syn::bracketed!(content in input);
/// let y = content.parse()?;
/// let z = input.parse()?;
/// Ok(Self {
/// x,
/// bracket_token,
/// y,
/// z,
/// })
/// }
/// }
/// ```
///
/// If the field type is `Bracket` or `Paren` or `Brace`, the symbol corresponding to the token type must be specified.
///
/// If the field type is `MacroDelimiter`, any symbol can be used and there is no difference in behavior. (Three types of parentheses are available, no matter which symbol is specified.)
///
/// | field type | start | end |
/// | ------------------------------ | ----------------------- | ----------------------- |
/// | [`struct@syn::token::Bracket`] | `"["` | `"]"` |
/// | [`struct@syn::token::Paren`] | `"("` | `")"` |
/// | [`struct@syn::token::Brace`] | `"{"` | `"}"` |
/// | [`enum@syn::MacroDelimiter`] | `"["` or `"("` or `"{"` | `"]"` or `")"` or `"}"` |
///
/// ## `#[parse(peek)]`
///
/// When parsing an enum, it will peek the field with this attribute set,
/// and if successful, will parse the variant containing the field.
/// If the peek succeeds, the subsequent variant will not be parsed even if the parse failed.
///
/// Variant where `#[parse(peek)]` is not specified will fork input and parse.
///
/// If the peek fails or the parsing of the forked input fails, the subsequent variant will be parsed.
///
/// ```rust
/// use syn::{LitInt, LitStr};
/// #[derive(structmeta::Parse)]
/// enum Example {
/// A(#[parse(peek)] LitInt, LitInt),
/// B(LitStr),
/// }
/// ```
///
/// Code like this will be generated:
///
/// ```rust
/// # use syn::{LitInt, LitStr};
/// # enum Example {
/// # A(LitInt, LitInt),
/// # B(LitStr),
/// # }
/// impl syn::parse::Parse for Example {
/// fn parse(input: syn::parse::ParseStream) -> syn::Result<Self> {
/// if input.peek(LitInt) {
/// let a_0 = input.parse()?;
/// let a_1 = input.parse()?;
/// return Ok(Example::A(a_0, a_1));
/// }
/// let b_0 = input.parse()?;
/// Ok(Example::B(b_0))
/// }
/// }
/// ```
///
/// `#[parse(peek)]` can be specified on the first three `TokenTree` for each variant.
///
/// ```rust
/// use syn::{LitInt, LitStr};
/// #[derive(structmeta::Parse)]
/// enum Example {
/// A(#[parse(peek)] LitInt, #[parse(peek)]LitInt, #[parse(peek)]LitInt),
/// B(#[parse(peek)] LitStr),
/// }
/// ```
///
/// Since the tokens enclosed by the delimiter is treated as a single token tree, you can also specify `#[parse(peek)]` to the field with `#[to_tokens("]")]`, `#[to_tokens("}")]`, `#[to_tokens(")")]`.
///
/// ```rust
/// use syn::{token, LitInt, LitStr};
/// #[derive(structmeta::Parse)]
/// enum Example {
/// A {
/// #[parse(peek)]
/// #[to_tokens("{")]
/// a: token::Brace,
/// b: LitInt,
/// c: LitInt,
/// #[to_tokens("}")]
/// #[parse(peek)]
/// d: LitInt,
/// },
/// }
/// ```
///
/// To use `#[parse(peek)]` for a field that type is `Ident`, use `syn::Ident` instead of `proc_macro2::Ident`.
///
/// ```compile_fail
/// #[derive(structmeta::Parse)]
/// enum ExampleNg {
/// A(#[parse(peek)] proc_macro2::Ident),
/// }
/// ```
///
/// ```rust
/// #[derive(structmeta::Parse)]
/// enum ExampleOk {
/// A(#[parse(peek)] syn::Ident),
/// }
/// ```
///
/// ## `#[parse(any)]`
///
/// When parsing `Ident`, allow values that cannot be used as identifiers, such as keywords.
///
/// In other words, `Ident::parse_any` and `Ident::peek_any` was generated instead of `Ident::parse` and `Ident::peek`.
///
/// ```rust
/// use quote::quote;
/// use structmeta::Parse;
/// use syn::{parse2, Ident};
///
/// #[derive(Parse)]
/// struct WithAny(#[parse(any)] Ident);
///
/// #[derive(Parse)]
/// struct WithoutAny(Ident);
///
/// assert_eq!(parse2::<WithAny>(quote!(self)).is_ok(), true);
/// assert_eq!(parse2::<WithoutAny>(quote!(self)).is_ok(), false);
/// ```
///
/// ## `#[parse(terminated)]`
///
/// Use [`Punctuated::parse_terminated`](syn::punctuated::Punctuated::parse_terminated) to parse.
///
/// ```rust
/// use quote::quote;
/// use structmeta::Parse;
/// use syn::{parse2, punctuated::Punctuated, Ident, Token};
/// #[derive(Parse)]
/// struct Example(#[parse(terminated)] Punctuated<Ident, Token![,]>);
/// assert_eq!(parse2::<Example>(quote!(a, b, c)).is_ok(), true);
/// ```
///
/// `terminated` can also be used with `any`.
///
/// ```rust
/// use quote::quote;
/// use structmeta::Parse;
/// use syn::{parse2, punctuated::Punctuated, Ident, Token};
///
/// #[derive(Parse)]
/// struct WithAny(#[parse(terminated, any)] Punctuated<Ident, Token![,]>);
///
/// #[derive(Parse)]
/// struct WithoutAny(#[parse(terminated)] Punctuated<Ident, Token![,]>);
///
/// assert_eq!(parse2::<WithAny>(quote!(self, self)).is_ok(), true);
/// assert_eq!(parse2::<WithoutAny>(quote!(self, self)).is_ok(), false);
/// ```
///
/// ## `#[parse(dump)]`
///
/// Causes a compile error and outputs the code generated by `#[derive(Parse)]` as an error message.
// #[include_doc("../../doc/parse.md", end)]
pub use structmeta_derive::Parse;
// #[include_doc("../../doc/struct_meta.md", start)]
/// Derive [`syn::parse::Parse`] for parsing attribute arguments.
///
/// - [Example](#example)
/// - [Named parameter](#named-parameter)
/// - [Supported field types for named parameter](#supported-field-types-for-named-parameter)
/// - [Flag style](#flag-style)
/// - [NameValue style](#namevalue-style)
/// - [NameValue or Flag style](#namevalue-or-flag-style)
/// - [NameArgs style](#nameargs-style)
/// - [NameArgs or Flag style](#nameargs-or-flag-style)
/// - [NameArgList style](#namearglist-style)
/// - [NameArgList or Flag style](#namearglist-or-flag-style)
/// - [Optional named parameter](#optional-named-parameter)
/// - [Rest named parameter](#rest-named-parameter)
/// - [Unnamed parameter](#unnamed-parameter)
/// - [Required unnamed parameter](#required-unnamed-parameter)
/// - [Optional unnamed parameter](#optional-unnamed-parameter)
/// - [Variadic unnamed parameter](#variadic-unnamed-parameter)
/// - [Parameter order](#parameter-order)
/// - [Helper attribute `#[struct_meta(...)]`](#helper-attribute-struct_meta)
/// - [Uses with `#[proc_macro_derive]`](#uses-with-proc_macro_derive)
/// - [Uses with `#[proc_macro_attribute]`](#uses-with-proc_macro_attribute)
/// - [Parsing ambiguous arguments](#parsing-ambiguous-arguments)
/// - [`#[struct_meta(name_filter = "...")]`](#struct_metaname_filter--)
///
/// # Example
///
/// ```rust
/// use structmeta::StructMeta;
/// use syn::{parse_quote, Attribute};
/// use syn::{LitInt, LitStr};
///
/// #[derive(StructMeta)]
/// struct Args {
/// #[struct_meta(unnamed)]
/// a: LitStr,
/// b: LitInt,
/// c: Option<LitInt>,
/// }
///
/// let attr: Attribute = parse_quote!(#[attr("xyz", b = 10)]);
/// let args: Args = attr.parse_args()?;
/// assert_eq!(args.a.value(), "xyz");
/// assert_eq!(args.b.base10_parse::<u32>()?, 10);
/// assert!(args.c.is_none());
/// # syn::Result::Ok(())
/// ```
///
/// # Named parameter
///
/// The following field will be "Named parameter".
///
/// - field in record struct.
/// - field with `#[struct_meta(name = "...")]` in tuple struct.
/// - However, fields that meet the following conditions are excluded
/// - field with `#[struct_meta(unnamed)]`
/// - field with type `HashMap<String, _>`
///
/// "Named parameter" is a parameter that specifies with a name, such as `#[attr(flag, x = 10, y(1, 2, 3))]`.
///
/// ## Supported field types for named parameter
///
/// "Named parameter" has the following four styles, and the style is determined by the type of the field.
///
/// - Flag style : `name`
/// - NameValue style : `name = value`
/// - NameArgs style : `name(args)`
/// - NameArgList style : `name(arg, arg, ...)`
///
/// | field type | field type (with span) | style | example |
/// | ---------- | ---------------------------- | ------------------------------------------------- | ------------------------------- |
/// | `bool` | [`Flag`] | [Flag](#flag-style) | `name` |
/// | `T` | [`NameValue<T>`] | [NameValue](#namevalue-style) | `name = value` |
/// | | [`NameValue<Option<T>>`] | [NameValue or Flag](#namevalue-or-flag-style) | `name = value` or `name` |
/// | | [`NameArgs<T>`] | [NameArgs](#nameargs-or-flag-style) | `name(args)` |
/// | | [`NameArgs<Option<T>>`] | [NameArgs or Flag](#nameargs-or-flag-style) | `name(args)` or `name` |
/// | `Vec<T>` | [`NameArgs<Vec<T>>`] | [NameArgList](#namearglist-style) | `name(arg, arg, ...)` |
/// | | [`NameArgs<Option<Vec<T>>>`] | [NameArgList or Flag](#namearglist-or-flag-style) | `name(arg, arg, ...)` or `name` |
///
/// Note: the type `T` in the table above needs to implement `syn::parse::Parse`.
///
/// With the above type as P (`bool` and `Flag` are excluded), you can also use the following types.
///
/// | field type | effect |
/// | -------------------- | ----------------------------------------------- |
/// | `Option<P>` | [optional parameter](#optional-named-parameter) |
/// | `HashMap<String, P>` | [rest parameter](#rest-named-parameter) |
///
/// ## Flag style
///
/// A field with the type `bool` will be a parameter that specifies only its name.
///
/// ```rust
/// use structmeta::StructMeta;
/// use syn::{parse_quote, Attribute};
///
/// #[derive(StructMeta)]
/// struct Args {
/// a: bool,
/// b: bool,
/// }
///
/// let attr: Attribute = parse_quote!(#[attr(a)]);
/// let args: Args = attr.parse_args()?;
/// assert_eq!(args.a, true);
/// assert_eq!(args.b, false);
///
/// let attr: Attribute = parse_quote!(#[attr(a, b)]);
/// let args: Args = attr.parse_args()?;
/// assert_eq!(args.a, true);
/// assert_eq!(args.b, true);
/// # syn::Result::Ok(())
/// ```
///
/// If you use `Flag` instead of `bool`, you will get its `Span` when the argument is specified.
///
/// ```rust
/// use structmeta::{Flag, StructMeta};
/// use syn::{parse_quote, Attribute};
///
/// #[derive(StructMeta)]
/// struct Args {
/// a: Flag,
/// }
///
/// let attr: Attribute = parse_quote!(#[attr(a)]);
/// let args: Args = attr.parse_args()?;
/// if let Some(_span) = args.a.span {
/// // Use span.
/// }
/// # syn::Result::Ok(())
/// ```
///
/// ## NameValue style
///
/// A field with type `T` or `NameValue<T>` will be `name = value` style parameter.
///
/// ```rust
/// use structmeta::{NameValue, StructMeta};
/// use syn::{parse_quote, Attribute, LitInt, LitStr};
///
/// #[derive(StructMeta)]
/// struct Args {
/// a: LitStr,
/// b: NameValue<LitInt>,
/// }
///
/// let attr: Attribute = parse_quote!(#[attr(a = "abc", b = 10)]);
/// let args: Args = attr.parse_args()?;
/// assert_eq!(args.a.value(), "abc");
/// assert_eq!(args.b.value.base10_parse::<u32>()?, 10);
/// # syn::Result::Ok(())
/// ```
///
/// ## NameValue or Flag style
///
/// A field with type `NameArgs<Option<T>>` will be `name = value` or `name` style parameter.
///
/// ```rust
/// use structmeta::{NameValue, StructMeta};
/// use syn::{parse_quote, Attribute, LitInt, LitStr};
///
/// #[derive(StructMeta)]
/// struct Args {
/// a: NameValue<Option<LitStr>>,
/// b: NameValue<Option<LitInt>>,
/// }
///
/// let attr: Attribute = parse_quote!(#[attr(a, b = 10)]);
/// let args: Args = attr.parse_args()?;
/// assert!(args.a.value.is_none());
/// assert_eq!(args.b.value.unwrap().base10_parse::<u32>()?, 10);
/// # syn::Result::Ok(())
/// ```
///
/// ## NameArgs style
///
/// A field with type `NameArgs<T>` will be `name(args)` style parameter.
///
/// ```rust
/// use structmeta::{NameArgs, StructMeta};
/// use syn::{parse_quote, Attribute, LitInt, LitStr};
///
/// #[derive(StructMeta)]
/// struct Args {
/// a: NameArgs<LitStr>,
/// b: NameArgs<LitInt>,
/// }
///
/// let attr: Attribute = parse_quote!(#[attr(a("abc"), b(10))]);
/// let args: Args = attr.parse_args()?;
/// assert_eq!(args.a.args.value(), "abc");
/// assert_eq!(args.b.args.base10_parse::<u32>()?, 10);
/// # syn::Result::Ok(())
/// ```
///
/// ## NameArgs or Flag style
///
/// A field with type `NameArgs<Option<T>>` will be `name(args)` or `name` style parameter.
///
/// ```rust
/// use structmeta::{NameArgs, StructMeta};
/// use syn::{parse_quote, Attribute, LitInt, LitStr};
///
/// #[derive(StructMeta)]
/// struct Args {
/// a: NameArgs<Option<LitStr>>,
/// b: NameArgs<Option<LitInt>>,
/// }
///
/// let attr: Attribute = parse_quote!(#[attr(a, b(10))]);
/// let args: Args = attr.parse_args()?;
/// assert!(args.a.args.is_none());
/// assert_eq!(args.b.args.unwrap().base10_parse::<u32>()?, 10);
/// # syn::Result::Ok(())
/// ```
///
/// ## NameArgList style
///
/// A field with type `NameArgs<Vec<T>>` will be `name(arg, arg, ...)` style parameter.
///
/// ```rust
/// use structmeta::{NameArgs, StructMeta};
/// use syn::{parse_quote, Attribute, LitStr};
///
/// #[derive(StructMeta)]
/// struct Args {
/// a: NameArgs<Vec<LitStr>>,
/// }
///
/// let attr: Attribute = parse_quote!(#[attr(a())]);
/// let args: Args = attr.parse_args()?;
/// assert_eq!(args.a.args.len(), 0);
///
/// let attr: Attribute = parse_quote!(#[attr(a("x"))]);
/// let args: Args = attr.parse_args()?;
/// assert_eq!(args.a.args.len(), 1);
///
/// let attr: Attribute = parse_quote!(#[attr(a("x", "y"))]);
/// let args: Args = attr.parse_args()?;
/// assert_eq!(args.a.args.len(), 2);
/// # syn::Result::Ok(())
/// ```
///
/// ## NameArgList or Flag style
///
/// A field with type `NameArgs<Option<Vec<T>>>` will be `name(arg, arg, ...)` or `name` style parameter.
///
/// ```rust
/// use structmeta::{NameArgs, StructMeta};
/// use syn::{parse_quote, Attribute, LitStr};
///
/// #[derive(StructMeta)]
/// struct Args {
/// abc: NameArgs<Option<Vec<LitStr>>>,
/// }
///
/// let attr: Attribute = parse_quote!(#[attr(abc)]);
/// let args: Args = attr.parse_args()?;
/// assert_eq!(args.abc.args.is_none(), true);
///
/// let attr: Attribute = parse_quote!(#[attr(abc())]);
/// let args: Args = attr.parse_args()?;
/// assert_eq!(args.abc.args.unwrap().len(), 0);
///
/// let attr: Attribute = parse_quote!(#[attr(abc("x"))]);
/// let args: Args = attr.parse_args()?;
/// assert_eq!(args.abc.args.unwrap().len(), 1);
///
/// let attr: Attribute = parse_quote!(#[attr(abc("x", "y"))]);
/// let args: Args = attr.parse_args()?;
/// assert_eq!(args.abc.args.unwrap().len(), 2);
/// # syn::Result::Ok(())
/// ```
///
/// ## Optional named parameter
///
/// If you use `Option` for the field type, it becomes an optional parameter.
///
/// ```rust
/// use structmeta::{NameValue, StructMeta};
/// use syn::{parse_quote, Attribute, LitInt, LitStr};
///
/// #[derive(StructMeta)]
/// struct Args {
/// a: Option<LitStr>,
/// b: Option<NameValue<LitInt>>,
/// }
///
/// let attr: Attribute = parse_quote!(#[attr(a = "abc")]);
/// let args: Args = attr.parse_args()?;
/// assert!(args.a.is_some());
/// assert!(args.b.is_none());
///
/// let attr: Attribute = parse_quote!(#[attr(b = 10)]);
/// let args: Args = attr.parse_args()?;
/// assert!(args.a.is_none());
/// assert!(args.b.is_some());
/// # syn::Result::Ok(())
/// ```
///
/// ## Rest named parameter
///
/// If `HashMap<String, _>` is used for the field type, the field will contain named arguments that are not associated with the field.
///
/// ```rust
/// use std::collections::HashMap;
/// use structmeta::StructMeta;
/// use syn::{parse_quote, Attribute, LitInt};
///
/// #[derive(StructMeta)]
/// struct Args {
/// a: Option<LitInt>,
/// rest: HashMap<String, LitInt>,
/// }
///
/// let attr: Attribute = parse_quote!(#[attr(a = 10, b = 20, c = 30)]);
/// let args: Args = attr.parse_args()?;
/// assert!(args.a.is_some());
/// let mut keys: Vec<_> = args.rest.keys().collect();
/// keys.sort();
/// assert_eq!(keys, vec!["b", "c"]);
/// # syn::Result::Ok(())
/// ```
///
/// # Unnamed parameter
///
/// The following field will be "Unnamed parameter".
///
/// - field in tuple struct.
/// - field with `#[struct_meta(unnamed)]` in record struct.
/// - However, fields that meet the following conditions are excluded
/// - field with `#[struct_meta(name = "...")]`
/// - field with type `HashMap<String, _>`
///
/// "Unnamed parameter" is a value-only parameter, such as `#[attr("abc", 10, 20)]`.
///
/// | field type | effect |
/// | ----------- | ------------------------------------------------- |
/// | `T` | [required parameter](#required-unnamed-parameter) |
/// | `Option<T>` | [optional parameter](#optional-unnamed-parameter) |
/// | `Vec<T>` | [variadic parameter](#variadic-unnamed-parameter) |
///
/// The type `T` in the table above needs to implement `syn::parse::Parse`.
///
/// ## Required unnamed parameter
///
/// Fields of the type that implement `syn::parse::Parse` will be required parameters.
///
/// ```rust
/// use structmeta::StructMeta;
/// use syn::{parse_quote, Attribute, LitStr, Result};
///
/// #[derive(StructMeta)]
/// struct Args(LitStr);
///
/// let attr: Attribute = parse_quote!(#[attr()]);
/// let args: Result<Args> = attr.parse_args();
/// assert!(args.is_err());
///
/// let attr: Attribute = parse_quote!(#[attr("a")]);
/// let args: Args = attr.parse_args()?;
/// assert_eq!(args.0.value(), "a");
/// # syn::Result::Ok(())
/// ```
///
/// ## Optional unnamed parameter
///
/// Fields of type `Option` will be optional parameters.
///
/// ```rust
/// use structmeta::StructMeta;
/// use syn::{parse_quote, Attribute, LitStr};
///
/// #[derive(StructMeta)]
/// struct Args(Option<LitStr>);
///
/// let attr: Attribute = parse_quote!(#[attr()]);
/// let args: Args = attr.parse_args()?;
/// assert!(args.0.is_none());
///
/// let attr: Attribute = parse_quote!(#[attr("a")]);
/// let args: Args = attr.parse_args()?;
/// assert_eq!(args.0.unwrap().value(), "a");
/// # syn::Result::Ok(())
/// ```
///
/// ## Variadic unnamed parameter
///
/// If you use `Vec` as the field type, multiple arguments can be stored in a single field.
///
/// ```rust
/// use structmeta::StructMeta;
/// use syn::{parse_quote, Attribute, LitStr};
///
/// #[derive(StructMeta)]
/// struct Args(Vec<LitStr>);
///
/// let attr: Attribute = parse_quote!(#[attr()]);
/// let args: Args = attr.parse_args()?;
/// assert_eq!(args.0.len(), 0);
///
/// let attr: Attribute = parse_quote!(#[attr("a")]);
/// let args: Args = attr.parse_args()?;
/// assert_eq!(args.0.len(), 1);
/// assert_eq!(args.0[0].value(), "a");
///
/// let attr: Attribute = parse_quote!(#[attr("a", "b")]);
/// let args: Args = attr.parse_args()?;
/// assert_eq!(args.0.len(), 2);
/// assert_eq!(args.0[0].value(), "a");
/// assert_eq!(args.0[1].value(), "b");
/// # syn::Result::Ok(())
/// ```
///
/// # Parameter order
///
/// The parameters must be in the following order.
///
/// - Unnamed
/// - Required
/// - Optional
/// - Variadic
/// - Named
///
/// # Helper attribute `#[struct_meta(...)]`
///
/// | argument | struct | field | effect |
/// | -------------------------------------------------- | ------ | ----- | ---------------------------------------------------------------------------------------- |
/// | `dump` | ✔ | | Causes a compile error and outputs the automatically generated code as an error message. |
/// | [`name_filter = "..."`](#struct_metaname_filter--) | ✔ | | Specify how to distinguish between a parameter name and a value of an unnamed parameter. |
/// | `name = "..."` | | ✔ | Specify a parameter name. |
/// | `unnamed` | | ✔ | Make the field be treated as an unnamed parameter. |
///
/// # Uses with `#[proc_macro_derive]`
///
/// A type with `#[derive(StructMeta)]` can be used with [`syn::Attribute::parse_args`].
///
/// ```rust
/// # extern crate proc_macro;
/// use proc_macro::TokenStream;
/// use quote::quote;
/// use structmeta::StructMeta;
/// use syn::{parse, parse_macro_input, DeriveInput, LitStr};
///
/// #[derive(StructMeta)]
/// struct MyAttr {
/// msg: LitStr,
/// }
///
/// # const IGNORE_TOKENS: &str = stringify! {
/// #[proc_macro_derive(MyMsg, attributes(my_msg))]
/// # };
/// pub fn derive_my_msg(input: TokenStream) -> TokenStream {
/// let input = parse_macro_input!(input as DeriveInput);
/// let mut msg = String::new();
/// for attr in input.attrs {
/// if attr.path().is_ident("my_msg") {
/// let attr = attr.parse_args::<MyAttr>().unwrap();
/// msg = attr.msg.value();
/// }
/// }
/// quote!(const MSG: &str = #msg;).into()
/// }
/// ```
///
/// ```ignore
/// #[derive(MyMsg)]
/// #[my_msg(msg = "abc")]
/// struct TestType;
///
/// assert_eq!(MSG, "abc");
/// ```
///
/// # Uses with `#[proc_macro_attribute]`
///
/// A type with `#[derive(StructMeta)]` can be used with `attr` parameter in attribute proc macro.
///
/// ```rust
/// # extern crate proc_macro;
/// use proc_macro::TokenStream;
/// use quote::quote;
/// use structmeta::StructMeta;
/// use syn::{parse, parse_macro_input, DeriveInput, LitStr};
///
/// #[derive(StructMeta)]
/// struct MyAttr {
/// msg: LitStr,
/// }
/// # const IGNORE_TOKENS: &str = stringify! {
/// #[proc_macro_attribute]
/// # };
/// pub fn my_attr(attr: TokenStream, _item: TokenStream) -> TokenStream {
/// let attr = parse::<MyAttr>(attr).unwrap();
/// let msg = attr.msg.value();
/// quote!(const MSG: &str = #msg;).into()
/// }
/// ```
///
/// ```ignore
/// #[my_attr(msg = "xyz")]
/// struct TestType;
///
/// assert_eq!(MSG, "xyz");
/// ```
///
/// # Parsing ambiguous arguments
///
/// If one or more `name = value` style parameters are defined, arguments beginning with `name =` will be parsed as `name = value` style,
/// even if the name is different from what it is defined as.
///
/// This specification is intended to prevent `name = value` from being treated as unnamed parameter due to typo.
///
/// ```rust
/// use structmeta::StructMeta;
/// use syn::{parse_quote, Attribute, Expr, LitInt, Result};
///
/// #[derive(StructMeta)]
/// struct WithNamed {
/// #[struct_meta(unnamed)]
/// unnamed: Option<Expr>,
/// x: Option<LitInt>,
/// }
///
/// let attr_x: Attribute = parse_quote!(#[attr(x = 10)]);
/// let result: WithNamed = attr_x.parse_args().unwrap();
/// assert_eq!(result.unnamed.is_some(), false);
/// assert_eq!(result.x.is_some(), true);
///
/// // `y = 10` is parsed as a wrong named parameter.
/// let attr_y: Attribute = parse_quote!(#[attr(y = 10)]);
/// let result: Result<WithNamed> = attr_y.parse_args();
/// assert!(result.is_err());
/// ```
///
/// If `name = value` style parameter is not defined, it will be parsed as unnamed parameter.
///
/// ```rust
/// use structmeta::StructMeta;
/// use syn::{parse_quote, Attribute, Expr, LitInt, Result};
///
/// #[derive(StructMeta)]
/// struct WithoutNamed {
/// #[struct_meta(unnamed)]
/// unnamed: Option<Expr>,
/// }
///
/// // `y = 10` is parsed as a unnamed parameter.
/// let attr_y: Attribute = parse_quote!(#[attr(y = 10)]);
/// let result: WithoutNamed = attr_y.parse_args().unwrap();
/// assert_eq!(result.unnamed, Some(parse_quote!(y = 10)));
/// ```
///
/// Similarly, if one or more `name(args)` style parameters are defined, arguments with `name(args)` will be parsed as `name(args)` style.
/// If `name(args)` style parameter is not defined, it will be parsed as unnamed parameter.
///
/// The same is true for `name` or `name = value` style parameter.
///
/// ## `#[struct_meta(name_filter = "...")]`
///
/// By attaching `#[struct_meta(name_filter = "...")]` to struct definition, you can restrict the names that can be used as parameter names and treat other identifiers as a value of unnamed parameter.
///
/// The following value can be used.
///
/// - `"snake_case"`
///
/// ```rust
/// use structmeta::StructMeta;
/// use syn::{parse_quote, Attribute, Expr, LitInt, Result};
///
/// let attr_x: Attribute = parse_quote!(#[attr(X)]);
/// let attr_y: Attribute = parse_quote!(#[attr(Y)]);
///
/// #[derive(StructMeta)]
/// struct NoFilter {
/// #[struct_meta(unnamed)]
/// unnamed: Option<Expr>,
/// #[struct_meta(name = "X")]
/// x: bool,
/// }
/// let result: NoFilter = attr_x.parse_args().unwrap();
/// assert_eq!(result.unnamed, None);
/// assert_eq!(result.x, true); // `X` is parsed as a named parameter.
///
/// let result: Result<NoFilter> = attr_y.parse_args();
/// assert!(result.is_err()); // `Y` is parsed as a wrong named parameter.
///
///
/// #[derive(StructMeta)]
/// #[struct_meta(name_filter = "snake_case")]
/// struct WithFilter {
/// #[struct_meta(unnamed)]
/// unnamed: Option<Expr>,
/// #[struct_meta(name = "X")]
/// x: bool,
/// }
/// let result: WithFilter = attr_x.parse_args().unwrap();
/// assert_eq!(result.unnamed, Some(parse_quote!(X))); // `X` is parsed as a unnamed parameter.
/// assert_eq!(result.x, false);
/// ```
// #[include_doc("../../doc/struct_meta.md", end)]
pub use structmeta_derive::StructMeta;