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
use core::{any::type_name, fmt};

use syn::{
    token::Mut, AngleBracketedGenericArguments, Expr, ExprLit, GenericArgument, Ident, Lit,
    LitBool, LitFloat, LitInt, Path, PathArguments, PathSegment, Type, TypeArray, TypePath,
    TypeReference, TypeTuple,
};

/// A writer for simplified type names.
///
/// By default type names are fully qualified which sometimes isn't desired. This type can be used
/// to print the types names in a simplified form:
///
/// ```
/// use core::any::type_name;
/// use mirror_mirror::type_info::SimpleTypeName;
///
/// // the default, fully qualified type name
/// assert_eq!(
///     type_name::<Option<String>>(),
///     "core::option::Option<alloc::string::String>",
/// );
///
/// // the simplified type name which is less verbose
/// assert_eq!(
///     SimpleTypeName::new_from_type::<Option<String>>().to_string(),
///     "Option<String>",
/// );
/// ```
///
/// # Not all types are supported
///
/// `SimpleTypeName` doesn't support printing absolutely all Rust types. It supports the most
/// common ones but exotic types like function pointers or trait objects are not supported. Such
/// types don't implement [`DescribeType`](super::DescribeType) anyway and are unlikely to show up when using
/// `mirror-mirror`.
///
/// Thus be careful when calling `to_string()` or using `format!()` as those will panic on
/// unsupported types:
///
/// ```should_panic
/// use mirror_mirror::type_info::SimpleTypeName;
///
/// format!("{}", SimpleTypeName::new_from_type::<fn() -> i32>());
/// ```
///
/// Instead use `write!` which allows handling the error
///
/// ```
/// use mirror_mirror::type_info::SimpleTypeName;
/// use core::fmt::Write;
///
/// let mut buf = String::new();
/// match write!(&mut buf, "{}", SimpleTypeName::new_from_type::<fn() -> i32>()) {
///     Ok(_) => {
///         // all good
///         # unreachable!();
///     }
///     Err(_) => {
///         // unsupported type
///         //
///         // instead just write the type we get directly from the compiler
///         buf.clear();
///         write!(&mut buf, "{}", core::any::type_name::<fn() -> i32>()).unwrap();
///         # assert_eq!(buf, "fn() -> i32");
///     }
/// }
/// ```
///
/// If you need a type that isn't supported feel free to submit a pull request!
#[allow(missing_debug_implementations)]
pub struct SimpleTypeName {
    ty: Type,
}

impl SimpleTypeName {
    pub fn new(type_name: &str) -> Option<Self> {
        let ty = syn::parse_str::<Type>(type_name).ok()?;
        Some(Self { ty })
    }

    pub fn new_from_type<T>() -> Self {
        Self::new(type_name::<T>()).expect("failed to parse type name")
    }
}

impl fmt::Display for SimpleTypeName {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        TypeWriter { f }.write(&self.ty)
    }
}

trait WriteAst<T> {
    fn write(&mut self, ty: &T) -> fmt::Result;
}

struct TypeWriter<'a, 'b> {
    f: &'a mut fmt::Formatter<'b>,
}

#[allow(clippy::wildcard_in_or_patterns)]
impl<'a, 'b> WriteAst<Type> for TypeWriter<'a, 'b> {
    fn write(&mut self, ty: &Type) -> fmt::Result {
        match ty {
            Type::Array(inner) => self.write(inner),
            Type::Path(inner) => self.write(inner),
            Type::Tuple(inner) => self.write(inner),
            Type::Reference(inner) => self.write(inner),
            Type::BareFn(_)
            | Type::Group(_)
            | Type::ImplTrait(_)
            | Type::Infer(_)
            | Type::Macro(_)
            | Type::Never(_)
            | Type::Paren(_)
            | Type::Ptr(_)
            | Type::Slice(_)
            | Type::TraitObject(_)
            | Type::Verbatim(_)
            | _ => Err(fmt::Error),
        }
    }
}

impl<'a, 'b> WriteAst<TypeArray> for TypeWriter<'a, 'b> {
    fn write(&mut self, array: &TypeArray) -> fmt::Result {
        let TypeArray {
            bracket_token: _,
            elem,
            semi_token: _,
            len,
        } = array;
        write!(self.f, "[")?;
        self.write(&**elem)?;
        write!(self.f, "; ")?;
        self.write(len)?;
        write!(self.f, "]")?;
        Ok(())
    }
}

#[allow(clippy::wildcard_in_or_patterns)]
impl<'a, 'b> WriteAst<Expr> for TypeWriter<'a, 'b> {
    fn write(&mut self, expr: &Expr) -> fmt::Result {
        match expr {
            Expr::Lit(inner) => self.write(inner),
            Expr::Array(_)
            | Expr::Assign(_)
            | Expr::AssignOp(_)
            | Expr::Async(_)
            | Expr::Await(_)
            | Expr::Binary(_)
            | Expr::Block(_)
            | Expr::Box(_)
            | Expr::Break(_)
            | Expr::Call(_)
            | Expr::Cast(_)
            | Expr::Closure(_)
            | Expr::Continue(_)
            | Expr::Field(_)
            | Expr::ForLoop(_)
            | Expr::Group(_)
            | Expr::If(_)
            | Expr::Index(_)
            | Expr::Let(_)
            | Expr::Loop(_)
            | Expr::Macro(_)
            | Expr::Match(_)
            | Expr::MethodCall(_)
            | Expr::Paren(_)
            | Expr::Path(_)
            | Expr::Range(_)
            | Expr::Reference(_)
            | Expr::Repeat(_)
            | Expr::Return(_)
            | Expr::Struct(_)
            | Expr::Try(_)
            | Expr::TryBlock(_)
            | Expr::Tuple(_)
            | Expr::Type(_)
            | Expr::Unary(_)
            | Expr::Unsafe(_)
            | Expr::Verbatim(_)
            | Expr::While(_)
            | Expr::Yield(_)
            | _ => Err(fmt::Error),
        }
    }
}

impl<'a, 'b> WriteAst<ExprLit> for TypeWriter<'a, 'b> {
    fn write(&mut self, lit: &ExprLit) -> fmt::Result {
        let ExprLit { attrs: _, lit } = lit;
        self.write(lit)?;
        Ok(())
    }
}

impl<'a, 'b> WriteAst<Lit> for TypeWriter<'a, 'b> {
    fn write(&mut self, lit: &Lit) -> fmt::Result {
        match lit {
            Lit::Int(inner) => self.write(inner),
            Lit::Bool(inner) => self.write(inner),
            Lit::Float(inner) => self.write(inner),
            Lit::Str(_) | Lit::ByteStr(_) | Lit::Byte(_) | Lit::Char(_) | Lit::Verbatim(_) => {
                Err(fmt::Error)
            }
        }
    }
}

impl<'a, 'b> WriteAst<LitInt> for TypeWriter<'a, 'b> {
    fn write(&mut self, lit: &LitInt) -> fmt::Result {
        write!(self.f, "{lit}")
    }
}

impl<'a, 'b> WriteAst<LitFloat> for TypeWriter<'a, 'b> {
    fn write(&mut self, lit: &LitFloat) -> fmt::Result {
        write!(self.f, "{lit}")
    }
}

impl<'a, 'b> WriteAst<LitBool> for TypeWriter<'a, 'b> {
    fn write(&mut self, lit: &LitBool) -> fmt::Result {
        write!(self.f, "{}", lit.value)
    }
}

impl<'a, 'b> WriteAst<TypePath> for TypeWriter<'a, 'b> {
    fn write(&mut self, ty: &TypePath) -> fmt::Result {
        let TypePath { qself, path } = ty;
        if qself.is_some() {
            return Err(fmt::Error);
        }
        self.write(path)?;
        Ok(())
    }
}

impl<'a, 'b> WriteAst<Path> for TypeWriter<'a, 'b> {
    fn write(&mut self, path: &Path) -> fmt::Result {
        let Path {
            leading_colon: _,
            segments,
        } = path;
        let last = segments.last().ok_or(fmt::Error)?;
        self.write(last)?;
        Ok(())
    }
}

impl<'a, 'b> WriteAst<PathSegment> for TypeWriter<'a, 'b> {
    fn write(&mut self, path_segment: &PathSegment) -> fmt::Result {
        let PathSegment { ident, arguments } = path_segment;
        self.write(ident)?;
        self.write(arguments)?;
        Ok(())
    }
}

impl<'a, 'b> WriteAst<Ident> for TypeWriter<'a, 'b> {
    fn write(&mut self, ident: &Ident) -> fmt::Result {
        write!(self.f, "{ident}")?;
        Ok(())
    }
}

impl<'a, 'b> WriteAst<PathArguments> for TypeWriter<'a, 'b> {
    fn write(&mut self, args: &PathArguments) -> fmt::Result {
        match args {
            PathArguments::None => Ok(()),
            PathArguments::AngleBracketed(inner) => self.write(inner),
            PathArguments::Parenthesized(_) => Err(fmt::Error),
        }
    }
}

impl<'a, 'b> WriteAst<AngleBracketedGenericArguments> for TypeWriter<'a, 'b> {
    fn write(&mut self, args: &AngleBracketedGenericArguments) -> fmt::Result {
        let AngleBracketedGenericArguments {
            colon2_token: _,
            lt_token: _,
            args,
            gt_token: _,
        } = args;
        write!(self.f, "<")?;
        let mut args = args.iter().peekable();
        while let Some(arg) = args.next() {
            self.write(arg)?;
            if args.peek().is_some() {
                write!(self.f, ", ")?;
            }
        }
        write!(self.f, ">")?;
        Ok(())
    }
}

impl<'a, 'b> WriteAst<GenericArgument> for TypeWriter<'a, 'b> {
    fn write(&mut self, arg: &GenericArgument) -> fmt::Result {
        match arg {
            GenericArgument::Type(inner) => self.write(inner),
            GenericArgument::Const(inner) => self.write(inner),
            GenericArgument::Lifetime(_)
            | GenericArgument::Binding(_)
            | GenericArgument::Constraint(_) => Err(fmt::Error),
        }
    }
}

impl<'a, 'b> WriteAst<TypeTuple> for TypeWriter<'a, 'b> {
    fn write(&mut self, ty: &TypeTuple) -> fmt::Result {
        let TypeTuple {
            paren_token: _,
            elems,
        } = ty;
        write!(self.f, "(")?;
        if elems.len() == 1 {
            for elem in elems {
                self.write(elem)?;
                write!(self.f, ",")?;
            }
        } else {
            let mut elems = elems.iter().peekable();
            while let Some(elem) = elems.next() {
                self.write(elem)?;
                if elems.peek().is_some() {
                    write!(self.f, ", ")?;
                }
            }
        }
        write!(self.f, ")")?;
        Ok(())
    }
}

impl<'a, 'b> WriteAst<TypeReference> for TypeWriter<'a, 'b> {
    fn write(&mut self, ty_ref: &TypeReference) -> fmt::Result {
        let TypeReference {
            and_token: _,
            // type names don't include lifetimes
            lifetime: _,
            mutability,
            elem,
        } = ty_ref;
        write!(self.f, "&")?;
        if let Some(mutability) = mutability {
            self.write(mutability)?;
            write!(self.f, " ")?;
        }
        self.write(&**elem)?;
        Ok(())
    }
}

impl<'a, 'b> WriteAst<Mut> for TypeWriter<'a, 'b> {
    fn write(&mut self, _: &Mut) -> fmt::Result {
        write!(self.f, "mut")
    }
}