 ffc572728f
			
		
	
	
		ffc572728f
		
			
		
	
	
	
	
		
			
			# Objective
Fix typos throughout the project.
## Solution
[`typos`](https://github.com/crate-ci/typos) project was used for
scanning, but no automatic corrections were applied. I checked
everything by hand before fixing.
Most of the changes are documentation/comments corrections. Also, there
are few trivial changes to code (variable name, pub(crate) function name
and a few error/panic messages).
## Unsolved
`bevy_reflect_derive` has
[typo](1b51053f19/crates/bevy_reflect/bevy_reflect_derive/src/type_path.rs (L76))
in enum variant name that I didn't fix. Enum is `pub(crate)`, so there
shouldn't be any trouble if fixed. However, code is tightly coupled with
macro usage, so I decided to leave it for more experienced contributor
just in case.
		
	
			
		
			
				
	
	
		
			120 lines
		
	
	
		
			3.6 KiB
		
	
	
	
		
			Rust
		
	
	
	
	
	
			
		
		
	
	
			120 lines
		
	
	
		
			3.6 KiB
		
	
	
	
		
			Rust
		
	
	
	
	
	
| use proc_macro::TokenStream;
 | |
| use proc_macro2::{Span, TokenStream as TokenStream2};
 | |
| use quote::quote;
 | |
| use syn::{parse_macro_input, parse_quote, DeriveInput, Ident, LitStr, Path, Result};
 | |
| 
 | |
| pub fn derive_event(input: TokenStream) -> TokenStream {
 | |
|     let mut ast = parse_macro_input!(input as DeriveInput);
 | |
|     let bevy_ecs_path: Path = crate::bevy_ecs_path();
 | |
| 
 | |
|     ast.generics
 | |
|         .make_where_clause()
 | |
|         .predicates
 | |
|         .push(parse_quote! { Self: Send + Sync + 'static });
 | |
| 
 | |
|     let struct_name = &ast.ident;
 | |
|     let (impl_generics, type_generics, where_clause) = &ast.generics.split_for_impl();
 | |
| 
 | |
|     TokenStream::from(quote! {
 | |
|         impl #impl_generics #bevy_ecs_path::event::Event for #struct_name #type_generics #where_clause {
 | |
|         }
 | |
|     })
 | |
| }
 | |
| 
 | |
| pub fn derive_resource(input: TokenStream) -> TokenStream {
 | |
|     let mut ast = parse_macro_input!(input as DeriveInput);
 | |
|     let bevy_ecs_path: Path = crate::bevy_ecs_path();
 | |
| 
 | |
|     ast.generics
 | |
|         .make_where_clause()
 | |
|         .predicates
 | |
|         .push(parse_quote! { Self: Send + Sync + 'static });
 | |
| 
 | |
|     let struct_name = &ast.ident;
 | |
|     let (impl_generics, type_generics, where_clause) = &ast.generics.split_for_impl();
 | |
| 
 | |
|     TokenStream::from(quote! {
 | |
|         impl #impl_generics #bevy_ecs_path::system::Resource for #struct_name #type_generics #where_clause {
 | |
|         }
 | |
|     })
 | |
| }
 | |
| 
 | |
| pub fn derive_component(input: TokenStream) -> TokenStream {
 | |
|     let mut ast = parse_macro_input!(input as DeriveInput);
 | |
|     let bevy_ecs_path: Path = crate::bevy_ecs_path();
 | |
| 
 | |
|     let attrs = match parse_component_attr(&ast) {
 | |
|         Ok(attrs) => attrs,
 | |
|         Err(e) => return e.into_compile_error().into(),
 | |
|     };
 | |
| 
 | |
|     let storage = storage_path(&bevy_ecs_path, attrs.storage);
 | |
| 
 | |
|     ast.generics
 | |
|         .make_where_clause()
 | |
|         .predicates
 | |
|         .push(parse_quote! { Self: Send + Sync + 'static });
 | |
| 
 | |
|     let struct_name = &ast.ident;
 | |
|     let (impl_generics, type_generics, where_clause) = &ast.generics.split_for_impl();
 | |
| 
 | |
|     TokenStream::from(quote! {
 | |
|         impl #impl_generics #bevy_ecs_path::component::Component for #struct_name #type_generics #where_clause {
 | |
|             type Storage = #storage;
 | |
|         }
 | |
|     })
 | |
| }
 | |
| 
 | |
| pub const COMPONENT: &str = "component";
 | |
| pub const STORAGE: &str = "storage";
 | |
| 
 | |
| struct Attrs {
 | |
|     storage: StorageTy,
 | |
| }
 | |
| 
 | |
| #[derive(Clone, Copy)]
 | |
| enum StorageTy {
 | |
|     Table,
 | |
|     SparseSet,
 | |
| }
 | |
| 
 | |
| // values for `storage` attribute
 | |
| const TABLE: &str = "Table";
 | |
| const SPARSE_SET: &str = "SparseSet";
 | |
| 
 | |
| fn parse_component_attr(ast: &DeriveInput) -> Result<Attrs> {
 | |
|     let mut attrs = Attrs {
 | |
|         storage: StorageTy::Table,
 | |
|     };
 | |
| 
 | |
|     for meta in ast.attrs.iter().filter(|a| a.path().is_ident(COMPONENT)) {
 | |
|         meta.parse_nested_meta(|nested| {
 | |
|             if nested.path.is_ident(STORAGE) {
 | |
|                 attrs.storage = match nested.value()?.parse::<LitStr>()?.value() {
 | |
|                     s if s == TABLE => StorageTy::Table,
 | |
|                     s if s == SPARSE_SET => StorageTy::SparseSet,
 | |
|                     s => {
 | |
|                         return Err(nested.error(format!(
 | |
|                             "Invalid storage type `{s}`, expected '{TABLE}' or '{SPARSE_SET}'.",
 | |
|                         )));
 | |
|                     }
 | |
|                 };
 | |
|                 Ok(())
 | |
|             } else {
 | |
|                 Err(nested.error("Unsupported attribute"))
 | |
|             }
 | |
|         })?;
 | |
|     }
 | |
| 
 | |
|     Ok(attrs)
 | |
| }
 | |
| 
 | |
| fn storage_path(bevy_ecs_path: &Path, ty: StorageTy) -> TokenStream2 {
 | |
|     let typename = match ty {
 | |
|         StorageTy::Table => Ident::new("TableStorage", Span::call_site()),
 | |
|         StorageTy::SparseSet => Ident::new("SparseStorage", Span::call_site()),
 | |
|     };
 | |
| 
 | |
|     quote! { #bevy_ecs_path::component::#typename }
 | |
| }
 |