189ceaf0d3
# Objective There are a lot of doctests that are `ignore`d for no documented reason. And that should be fixed. ## Solution I searched the bevy repo with the regex ` ```[a-z,]*ignore ` in order to find all `ignore`d doctests. For each one of the `ignore`d doctests, I did the following steps: 1. Attempt to remove the `ignored` attribute while still passing the test. I did this by adding hidden dummy structs and imports. 2. If step 1 doesn't work, attempt to replace the `ignored` attribute with the `no_run` attribute while still passing the test. 3. If step 2 doesn't work, keep the `ignored` attribute but add documentation for why the `ignored` attribute was added. --------- Co-authored-by: François <mockersf@gmail.com>
106 lines
2.7 KiB
Rust
106 lines
2.7 KiB
Rust
//! This module contains unit structs that should be used inside `quote!` and `spanned_quote!`
|
|
//! using the variable interpolation syntax in place of their equivalent structs and traits
|
|
//! present in `std`.
|
|
//!
|
|
//! To create hygienic proc macros, all the names must be its fully qualified form. These
|
|
//! unit structs help us to not specify the fully qualified name every single time.
|
|
//!
|
|
//! # Example
|
|
//! Instead of writing this:
|
|
//! ```
|
|
//! # use quote::quote;
|
|
//! quote!(
|
|
//! fn get_id() -> Option<i32> {
|
|
//! Some(0)
|
|
//! }
|
|
//! );
|
|
//! ```
|
|
//! Or this:
|
|
//! ```
|
|
//! # use quote::quote;
|
|
//! quote!(
|
|
//! fn get_id() -> ::core::option::Option<i32> {
|
|
//! ::core::option::Option::Some(0)
|
|
//! }
|
|
//! );
|
|
//! ```
|
|
//! We should write this:
|
|
//! ```
|
|
//! use bevy_macro_utils::fq_std::FQOption;
|
|
//! # use quote::quote;
|
|
//!
|
|
//! quote!(
|
|
//! fn get_id() -> #FQOption<i32> {
|
|
//! #FQOption::Some(0)
|
|
//! }
|
|
//! );
|
|
//! ```
|
|
|
|
use proc_macro2::TokenStream;
|
|
use quote::{quote, ToTokens};
|
|
|
|
/// Fully Qualified (FQ) short name for [`core::any::Any`]
|
|
pub struct FQAny;
|
|
/// Fully Qualified (FQ) short name for [`Box`]
|
|
pub struct FQBox;
|
|
/// Fully Qualified (FQ) short name for [`Clone`]
|
|
pub struct FQClone;
|
|
/// Fully Qualified (FQ) short name for [`Default`]
|
|
pub struct FQDefault;
|
|
/// Fully Qualified (FQ) short name for [`Option`]
|
|
pub struct FQOption;
|
|
/// Fully Qualified (FQ) short name for [`Result`]
|
|
pub struct FQResult;
|
|
/// Fully Qualified (FQ) short name for [`Send`]
|
|
pub struct FQSend;
|
|
/// Fully Qualified (FQ) short name for [`Sync`]
|
|
pub struct FQSync;
|
|
|
|
impl ToTokens for FQAny {
|
|
fn to_tokens(&self, tokens: &mut TokenStream) {
|
|
quote!(::core::any::Any).to_tokens(tokens);
|
|
}
|
|
}
|
|
|
|
impl ToTokens for FQBox {
|
|
fn to_tokens(&self, tokens: &mut TokenStream) {
|
|
quote!(::std::boxed::Box).to_tokens(tokens);
|
|
}
|
|
}
|
|
|
|
impl ToTokens for FQClone {
|
|
fn to_tokens(&self, tokens: &mut TokenStream) {
|
|
quote!(::core::clone::Clone).to_tokens(tokens);
|
|
}
|
|
}
|
|
|
|
impl ToTokens for FQDefault {
|
|
fn to_tokens(&self, tokens: &mut TokenStream) {
|
|
quote!(::core::default::Default).to_tokens(tokens);
|
|
}
|
|
}
|
|
|
|
impl ToTokens for FQOption {
|
|
fn to_tokens(&self, tokens: &mut TokenStream) {
|
|
quote!(::core::option::Option).to_tokens(tokens);
|
|
}
|
|
}
|
|
|
|
impl ToTokens for FQResult {
|
|
fn to_tokens(&self, tokens: &mut TokenStream) {
|
|
quote!(::core::result::Result).to_tokens(tokens);
|
|
}
|
|
}
|
|
|
|
impl ToTokens for FQSend {
|
|
fn to_tokens(&self, tokens: &mut TokenStream) {
|
|
quote!(::core::marker::Send).to_tokens(tokens);
|
|
}
|
|
}
|
|
|
|
impl ToTokens for FQSync {
|
|
fn to_tokens(&self, tokens: &mut TokenStream) {
|
|
quote!(::core::marker::Sync).to_tokens(tokens);
|
|
}
|
|
}
|