alloy_sol_type_parser/
tuple.rs

1use crate::{
2    Error, Input, Result, TypeSpecifier, new_input,
3    utils::{spanned, tuple_parser},
4};
5use alloc::vec::Vec;
6use winnow::{
7    ModalResult, Parser,
8    combinator::{opt, preceded, trace},
9};
10
11/// A tuple specifier, with no array suffixes. Corresponds to a sequence of
12/// types.
13///
14/// The internal types are all [`TypeSpecifier`], and may be arbitrarily
15/// complex.
16///
17/// # Examples
18///
19/// ```
20/// # use alloy_sol_type_parser::TupleSpecifier;
21/// let spec = TupleSpecifier::parse("(uint256,uint256)")?;
22/// assert_eq!(spec.span(), "(uint256,uint256)");
23/// assert_eq!(spec.types.len(), 2);
24/// assert_eq!(spec.types[0].span(), "uint256");
25///
26/// // No array suffixes. Use `TypeSpecifier` instead.
27/// assert!(TupleSpecifier::parse("(uint256,uint256)[]").is_err());
28/// # Ok::<_, alloy_sol_type_parser::Error>(())
29/// ```
30#[derive(Clone, Debug, PartialEq, Eq)]
31pub struct TupleSpecifier<'a> {
32    /// The full span of the tuple specifier.
33    pub span: &'a str,
34    /// The internal types.
35    pub types: Vec<TypeSpecifier<'a>>,
36}
37
38impl<'a> TryFrom<&'a str> for TupleSpecifier<'a> {
39    type Error = Error;
40
41    #[inline]
42    fn try_from(value: &'a str) -> Result<Self> {
43        Self::parse(value)
44    }
45}
46
47impl AsRef<str> for TupleSpecifier<'_> {
48    #[inline]
49    fn as_ref(&self) -> &str {
50        self.span()
51    }
52}
53
54impl<'a> TupleSpecifier<'a> {
55    /// Parse a tuple specifier from a string.
56    #[inline]
57    pub fn parse(input: &'a str) -> Result<Self> {
58        Self::parser.parse(new_input(input)).map_err(Error::parser)
59    }
60
61    /// [`winnow`] parser for this type.
62    pub(crate) fn parser(input: &mut Input<'a>) -> ModalResult<Self> {
63        trace("TupleSpecifier", spanned(Self::parse_types))
64            .parse_next(input)
65            .map(|(span, types)| Self { span, types })
66    }
67
68    #[inline]
69    fn parse_types(input: &mut Input<'a>) -> ModalResult<Vec<TypeSpecifier<'a>>> {
70        preceded(opt("tuple"), tuple_parser(TypeSpecifier::parser)).parse_next(input)
71    }
72
73    /// Returns the tuple specifier as a string.
74    #[inline]
75    pub const fn span(&self) -> &'a str {
76        self.span
77    }
78
79    /// Returns true if the type is a basic Solidity type.
80    #[inline]
81    pub fn try_basic_solidity(&self) -> Result<()> {
82        self.types.iter().try_for_each(TypeSpecifier::try_basic_solidity)
83    }
84}
85
86#[cfg(test)]
87mod test {
88    use super::*;
89
90    #[test]
91    fn extra_close_parens() {
92        TupleSpecifier::parse("bool,uint256))").unwrap_err();
93    }
94
95    #[test]
96    fn extra_open_parents() {
97        TupleSpecifier::parse("(bool,uint256").unwrap_err();
98    }
99
100    #[test]
101    fn nested_tuples() {
102        assert_eq!(
103            TupleSpecifier::parse("(bool,(uint256,uint256))").unwrap(),
104            TupleSpecifier {
105                span: "(bool,(uint256,uint256))",
106                types: vec![
107                    TypeSpecifier::parse("bool").unwrap(),
108                    TypeSpecifier::parse("(uint256,uint256)").unwrap(),
109                ]
110            }
111        );
112        assert_eq!(
113            TupleSpecifier::parse("(((bool),),)").unwrap(),
114            TupleSpecifier {
115                span: "(((bool),),)",
116                types: vec![TypeSpecifier::parse("((bool),)").unwrap()]
117            }
118        );
119    }
120
121    #[test]
122    fn does_not_parse_missing_parens() {
123        TupleSpecifier::parse("bool,uint256").unwrap_err();
124    }
125
126    #[test]
127    fn stack_overflow() {
128        let s = "((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((";
129        TupleSpecifier::parse(s).unwrap_err();
130    }
131}
alloy_sol_type_parser/tuple.rs

alloy_sol_type_parser/
tuple.rs
