sway-parse 0.71.0

Sway's parser
Documentation
use crate::{Parse, ParseResult, Parser};

use sway_ast::attribute::Annotated;
use sway_ast::keywords::{
    ConstToken, FnToken, OpenAngleBracketToken, SemicolonToken, TypeToken, WhereToken,
};
use sway_ast::{Braces, GenericParams, ItemImpl, ItemImplItem, PubToken, Ty};
use sway_error::parser_error::ParseErrorKind;

impl Parse for ItemImplItem {
    fn parse(parser: &mut Parser) -> ParseResult<ItemImplItem> {
        if parser.peek::<FnToken>().is_some()
            || (parser.peek::<PubToken>().is_some() && parser.peek_next::<FnToken>().is_some())
        {
            let fn_decl = parser.parse()?;
            Ok(ItemImplItem::Fn(fn_decl))
        } else if parser.peek::<ConstToken>().is_some()
            || (parser.peek::<PubToken>().is_some() && parser.peek_next::<ConstToken>().is_some())
        {
            let const_decl = parser.parse()?;
            parser.parse::<SemicolonToken>()?;
            Ok(ItemImplItem::Const(const_decl))
        } else if let Some(_type_keyword) = parser.peek::<TypeToken>() {
            let type_decl = parser.parse()?;
            parser.parse::<SemicolonToken>()?;
            Ok(ItemImplItem::Type(type_decl))
        } else {
            Err(parser.emit_error(ParseErrorKind::ExpectedAnItem))
        }
    }
}

impl Parse for ItemImpl {
    fn parse(parser: &mut Parser) -> ParseResult<ItemImpl> {
        let impl_token = parser.parse()?;
        let generic_params_opt = parser.guarded_parse::<OpenAngleBracketToken, GenericParams>()?;
        let ty = parser.parse::<Ty>()?;
        let (trait_opt, ty) = match parser.take() {
            Some(for_token) => match ty {
                Ty::Path(path_type) => (Some((path_type, for_token)), parser.parse()?),
                _ => {
                    return Err(parser.emit_error(ParseErrorKind::ExpectedPathType));
                }
            },
            None => (None, ty),
        };
        let where_clause_opt = parser.guarded_parse::<WhereToken, _>()?;
        let contents: Braces<Vec<Annotated<ItemImplItem>>> = parser.parse()?;
        if trait_opt.is_some() {
            for annotated in contents.get().iter() {
                if let ItemImplItem::Fn(item_fn) = &annotated.value {
                    parser.ban_visibility_qualifier(&item_fn.fn_signature.visibility)?;
                }
            }
        }
        Ok(ItemImpl {
            impl_token,
            generic_params_opt,
            trait_opt,
            ty,
            where_clause_opt,
            contents,
        })
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::test_utils::parse;
    use assert_matches::*;

    #[test]
    fn parse_impl_ptr() {
        let item = parse::<ItemImpl>(
            r#"
            impl __ptr[T] {}
            "#,
        );
        assert_matches!(item.ty, Ty::Ptr { .. });
    }

    #[test]
    fn parse_impl_for_ptr() {
        let item = parse::<ItemImpl>(
            r#"
            impl Foo for __ptr[T] {}
            "#,
        );
        assert_matches!(item.ty, Ty::Ptr { .. });
    }

    #[test]
    fn parse_impl_slice() {
        // deprecated syntax
        let item = parse::<ItemImpl>("impl __slice[T] {}");
        assert_matches!(
            item.ty,
            Ty::Slice {
                slice_token: Some(..),
                ty: _
            }
        );

        // "new" syntax
        let item = parse::<ItemImpl>("impl [T] {}");
        assert_matches!(
            item.ty,
            Ty::Slice {
                slice_token: None,
                ty: _
            }
        );

        let item = parse::<ItemImpl>("impl &[T] {}");
        assert_matches!(item.ty, Ty::Ref { ty, .. } if matches!(&*ty, Ty::Slice { .. }));
    }

    #[test]
    fn parse_impl_for_slice() {
        let item = parse::<ItemImpl>(
            r#"
            impl Foo for __slice[T] {}
            "#,
        );
        assert_matches!(item.ty, Ty::Slice { .. });
    }

    #[test]
    fn parse_impl_ref() {
        let item = parse::<ItemImpl>(
            r#"
            impl &T {}
            "#,
        );
        assert_matches!(
            item.ty,
            Ty::Ref {
                mut_token: None,
                ..
            }
        );
    }

    #[test]
    fn parse_impl_for_ref() {
        let item = parse::<ItemImpl>(
            r#"
            impl Foo for &T {}
            "#,
        );
        assert_matches!(
            item.ty,
            Ty::Ref {
                mut_token: None,
                ..
            }
        );
    }

    #[test]
    fn parse_impl_mut_ref() {
        let item = parse::<ItemImpl>(
            r#"
            impl &mut T {}
            "#,
        );
        assert_matches!(
            item.ty,
            Ty::Ref {
                mut_token: Some(_),
                ..
            }
        );
    }

    #[test]
    fn parse_impl_for_mut_ref() {
        let item = parse::<ItemImpl>(
            r#"
            impl Foo for &mut T {}
            "#,
        );
        assert_matches!(
            item.ty,
            Ty::Ref {
                mut_token: Some(_),
                ..
            }
        );
    }
}