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
use scale_info::{
    form::PortableForm, Field, PortableRegistry, Type, TypeDef, TypeDefPrimitive, TypeDefTuple,
    TypeDefVariant, Variant,
};

use crate::transformer::Transformer;

use super::formatting::format_type_description;

/// Describes the type that is registered under the given `type_id`. This type description
/// is supposed to be very close to actual rust types, with some minar differences:
/// - The `struct` keyword is omitted. So the description of `struct Human { age: u8 }` is just `Human { age: u8 }`.
/// - Types are presented in a nested fashion, similar to how structures can be defined in e.g. the C programming language.
///
/// If the `format` flag is enabled, the end result is formatted across multiple lines. Otherwise the description will be one single line string.
pub fn type_description(
    type_id: u32,
    type_registry: &PortableRegistry,
    format: bool,
) -> anyhow::Result<String> {
    fn return_type_name(
        _type_id: u32,
        ty: &Type<PortableForm>,
        transformer: &Transformer<String>,
    ) -> Option<anyhow::Result<String>> {
        if ty.path.ident().is_some() {
            return Some(Ok(type_name_with_type_params(ty, transformer.types())));
        }
        None
    }

    fn return_type_name_on_cache_hit(
        _type_id: u32,
        ty: &Type<PortableForm>,
        cached: &String,
        transformer: &Transformer<String>,
    ) -> Option<anyhow::Result<String>> {
        if ty.path.ident().is_some() {
            return Some(Ok(type_name_with_type_params(ty, transformer.types())));
        }
        Some(Ok(cached.to_owned()))
    }
    let transformer = Transformer::new(
        ty_description,
        return_type_name,
        return_type_name_on_cache_hit,
        (),
        type_registry,
    );
    let mut description = transformer.resolve(type_id)?;
    if format {
        description = format_type_description(&description);
    }
    Ok(description)
}

fn ty_description(
    _type_id: u32,
    ty: &Type<PortableForm>,
    transformer: &Transformer<String>,
) -> anyhow::Result<String> {
    let name_and_params = if ty.path.ident().is_some() {
        type_name_with_type_params(ty, transformer.types())
    } else {
        String::new()
    };

    let prefix = match &ty.type_def {
        TypeDef::Variant(_) => "enum ",
        TypeDef::Composite(_) => "struct ",
        _ => "",
    };
    let type_def_description = type_def_type_description(&ty.type_def, transformer)?;
    Ok(format!("{prefix}{name_and_params}{type_def_description}"))
}

/// Can be None for types that have an empty path
fn type_name_with_type_params(ty: &Type<PortableForm>, types: &PortableRegistry) -> String {
    match &ty.type_def {
        TypeDef::Sequence(s) => {
            let inner = type_name_with_type_params(types.resolve(s.type_param.id).unwrap(), types);
            return format!("Vec<{inner}>",);
        }
        TypeDef::Array(a) => {
            let inner = type_name_with_type_params(types.resolve(a.type_param.id).unwrap(), types);
            let len = a.len;
            return format!("[{inner};{len}]",);
        }
        TypeDef::Tuple(t) => {
            let mut output = "(".to_string();
            let mut iter = t.fields.iter().peekable();
            while let Some(ty) = iter.next() {
                let type_name = type_name_with_type_params(types.resolve(ty.id).unwrap(), types);
                output.push_str(&type_name);
                if iter.peek().is_some() || t.fields.len() == 1 {
                    output.push(',')
                }
            }
            output.push(')');
            return output;
        }
        TypeDef::Primitive(p) => return primitive_type_description(p).into(),
        TypeDef::Compact(c) => {
            let inner = type_name_with_type_params(types.resolve(c.type_param.id).unwrap(), types);
            return format!("Compact<{inner}>",);
        }
        TypeDef::BitSequence(_) => return "BitSequence".into(),
        TypeDef::Composite(_) => {}
        TypeDef::Variant(_) => {}
    }

    let Some(ident) = ty.path.ident() else {
        return "_".to_string(); // this should happen rarely
    };

    let params = ty
        .type_params
        .iter()
        .map(|e| {
            let Some(ty) = e.ty.as_ref() else {
                return "_".to_string();
            };

            let ty = types.resolve(ty.id).unwrap();
            type_name_with_type_params(ty, types)
        })
        .collect::<Vec<_>>()
        .join(",");

    if params.is_empty() {
        ident.to_string()
    } else {
        format!("{ident}<{}>", params)
    }
}

fn type_def_type_description(
    type_def: &TypeDef<PortableForm>,
    transformer: &Transformer<String>,
) -> anyhow::Result<String> {
    match type_def {
        TypeDef::Composite(composite) => fields_type_description(&composite.fields, transformer),
        TypeDef::Variant(variant) => variant_type_def_type_description(variant, transformer),
        TypeDef::Sequence(sequence) => Ok(format!(
            "Vec<{}>",
            transformer.resolve(sequence.type_param.id)?
        )),
        TypeDef::Array(array) => Ok(format!(
            "[{}; {}]",
            transformer.resolve(array.type_param.id)?,
            array.len
        )),
        TypeDef::Tuple(tuple) => tuple_type_description(tuple, transformer),
        TypeDef::Primitive(primitive) => Ok(primitive_type_description(primitive).into()),
        TypeDef::Compact(compact) => Ok(format!(
            "Compact<{}>",
            transformer.resolve(compact.type_param.id)?
        )),
        TypeDef::BitSequence(bit_sequence) => {
            let bit_order_type = transformer.resolve(bit_sequence.bit_order_type.id)?;
            let bit_store_type = transformer.resolve(bit_sequence.bit_store_type.id)?;
            Ok(format!("BitSequence({bit_order_type}, {bit_store_type})"))
        }
    }
}

fn tuple_type_description(
    tuple: &TypeDefTuple<PortableForm>,
    transformer: &Transformer<String>,
) -> anyhow::Result<String> {
    let mut output = "(".to_string();
    let mut iter = tuple.fields.iter().peekable();
    let field_count = tuple.fields.len();
    while let Some(ty) = iter.next() {
        let type_description = transformer.resolve(ty.id)?;
        output.push_str(&type_description);
        if iter.peek().is_some() || field_count == 1 {
            output.push(',')
        }
    }
    output.push(')');
    Ok(output)
}

fn primitive_type_description(primitive: &TypeDefPrimitive) -> &'static str {
    match &primitive {
        TypeDefPrimitive::Bool => "bool",
        TypeDefPrimitive::Char => "char",
        TypeDefPrimitive::Str => "String",
        TypeDefPrimitive::U8 => "u8",
        TypeDefPrimitive::U16 => "u16",
        TypeDefPrimitive::U32 => "u32",
        TypeDefPrimitive::U64 => "u64",
        TypeDefPrimitive::U128 => "u128",
        TypeDefPrimitive::U256 => "u256",
        TypeDefPrimitive::I8 => "i8",
        TypeDefPrimitive::I16 => "i16",
        TypeDefPrimitive::I32 => "i32",
        TypeDefPrimitive::I64 => "i64",
        TypeDefPrimitive::I128 => "i128",
        TypeDefPrimitive::I256 => "i256",
    }
}

fn variant_type_def_type_description(
    variant_type_def: &TypeDefVariant<PortableForm>,
    transformer: &Transformer<String>,
) -> anyhow::Result<String> {
    let mut variants_string = String::new();
    variants_string.push('{');
    let mut iter = variant_type_def.variants.iter().peekable();
    while let Some(variant) = iter.next() {
        let variant_string = variant_type_description(variant, transformer)?;
        variants_string.push_str(&variant_string);

        if iter.peek().is_some() {
            variants_string.push(',');
        }
    }
    variants_string.push('}');
    Ok(variants_string)
}

fn variant_type_description(
    variant: &Variant<PortableForm>,
    transformer: &Transformer<String>,
) -> anyhow::Result<String> {
    let fields_string = fields_type_description(&variant.fields, transformer)?;
    let output = if fields_string == "()" {
        variant.name.to_string()
    } else {
        format!("{}{}", &variant.name, fields_string)
    };
    Ok(output)
}

fn fields_type_description(
    fields: &[Field<PortableForm>],
    transformer: &Transformer<String>,
) -> anyhow::Result<String> {
    if fields.is_empty() {
        return Ok("()".to_string());
    }

    let all_fields_named = fields.iter().all(|f| f.name.is_some());
    let all_fields_unnamed = fields.iter().all(|f| f.name.is_none());
    let brackets = match (all_fields_named, all_fields_unnamed) {
        (true, false) => ('{', '}'),
        (false, true) => ('(', ')'),
        _ => {
            return Err(anyhow::anyhow!(
                "combination of named and unnamed fields in compound type"
            ));
        }
    };

    let mut fields_string = String::new();
    fields_string.push(brackets.0);
    let mut iter = fields.iter().peekable();
    while let Some(field) = iter.next() {
        let field_description = field_type_description(field, transformer)?;
        fields_string.push_str(&field_description);

        if iter.peek().is_some() {
            fields_string.push(',')
        }
    }
    fields_string.push(brackets.1);
    Ok(fields_string)
}

fn field_type_description(
    field: &Field<PortableForm>,
    transformer: &Transformer<String>,
) -> anyhow::Result<String> {
    let mut type_description = transformer.resolve(field.ty.id)?;
    let is_boxed = field
        .type_name
        .as_ref()
        .map(|e| e.contains("Box<"))
        .unwrap_or_default();
    if is_boxed {
        type_description = format!("Box<{}>", type_description);
    }

    let type_description_maybe_named = if let Some(name) = &field.name {
        format!("{}: {}", name, type_description)
    } else {
        type_description
    };
    Ok(type_description_maybe_named)
}