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
use std::fmt::{self, Write};

use crate::associated_type::AssociatedType;
use crate::bound::Bound;
use crate::formatter::{fmt_bound_rhs, Formatter};
use crate::function::Function;
use crate::type_def::TypeDef;

use crate::r#type::Type;

/// Defines a trait.
#[allow(dead_code)]
#[derive(Debug, Clone)]
pub struct Trait {
    /// The type definition of the trait.
    type_def: TypeDef,
    /// The trait's parent types.
    parents: Vec<Type>,
    /// The trait's associated types.
    associated_tys: Vec<AssociatedType>,
    /// The trait's functions.
    fns: Vec<Function>,
    /// The trait's macros.
    macros: Vec<String>,
}

impl Trait {
    /// Return a trait definition with the provided name.
    /// 
    /// # Arguments
    /// 
    /// * `name` - The name of the trait.
    /// 
    /// # Examples
    /// 
    /// ```
    /// use rust_codegen::Trait;
    /// 
    /// let foo_trait = Trait::new("Foo");
    /// ```
    pub fn new(name: &str) -> Self {
        Trait {
            type_def: TypeDef::new(name),
            parents: vec![],
            associated_tys: vec![],
            fns: vec![],
            macros: vec![],
        }
    }

    /// Returns a reference to the type.
    /// 
    /// # Examples
    /// 
    /// ```
    /// use rust_codegen::Trait;
    /// 
    /// let foo_trait = Trait::new("Foo");
    /// println!("{:?}", foo_trait.ty());
    /// ```
    pub fn ty(&self) -> &Type {
        &self.type_def.ty
    }

    /// Set the trait visibility.
    /// 
    /// # Arguments
    /// 
    /// * `vis` - The visibility to set for the trait.
    /// 
    /// # Examples
    /// 
    /// ```
    /// use rust_codegen::Trait;
    /// 
    /// let mut foo_trait = Trait::new("Foo");
    /// foo_trait.vis("pub");
    /// ```
    pub fn vis(&mut self, vis: &str) -> &mut Self {
        self.type_def.vis(vis);
        self
    }

    /// Add a generic to the trait.
    /// 
    /// # Examples
    /// 
    /// ```
    /// use rust_codegen::Trait;
    /// 
    /// let mut foo_trait = Trait::new("Foo");
    /// foo_trait.generic("T");
    /// ```
    pub fn generic(&mut self, name: &str) -> &mut Self {
        self.type_def.ty.generic(name);
        self
    }

    /// Add a `where` bound to the trait.
    /// 
    /// # Arguments
    /// 
    /// * `name` - The name of the bound.
    /// * `ty` - The type of the bound.
    /// 
    /// # Examples
    /// 
    /// ```
    /// use rust_codegen::Trait;
    /// 
    /// let mut foo_trait = Trait::new("Foo");
    /// foo_trait.bound("A", "String");
    /// ```
    pub fn bound<T>(&mut self, name: &str, ty: T) -> &mut Self
    where
        T: Into<Type>,
    {
        self.type_def.bound(name, ty);
        self
    }

    /// Add a macro to the trait def (e.g. `"#[async_trait]"`).
    /// 
    /// # Arguments 
    /// 
    /// * `r#macro` - The macro to add.
    /// 
    /// # Examples
    /// 
    /// ```
    /// use rust_codegen::Trait;
    /// 
    /// let mut foo_trait = Trait::new("Foo");
    /// foo_trait.r#macro("async_trait");
    /// ```
    pub fn r#macro(&mut self, r#macro: &str) -> &mut Self {
        self.type_def.r#macro(r#macro);
        self
    }

    /// Add a parent trait.
    /// 
    /// # Arguments
    /// 
    /// * `ty` - The type of the parent trait.
    /// 
    /// # Examples
    /// 
    /// ```
    /// use rust_codegen::Trait;
    /// 
    /// let mut foo_trait = Trait::new("Foo");
    /// foo_trait.parent("Bar");
    /// ```
    pub fn parent<T>(&mut self, ty: T) -> &mut Self
    where
        T: Into<Type>,
    {
        self.parents.push(ty.into());
        self
    }

    /// Set the trait documentation.
    /// 
    /// # Arguments
    /// 
    /// * `docs` - The documentation for the trait.
    /// 
    /// # Examples
    /// 
    /// ```
    /// use rust_codegen::Trait;
    /// 
    /// let mut foo_trait = Trait::new("Foo");
    /// foo_trait.doc("Sample trait documentation.");
    /// ```
    pub fn doc(&mut self, docs: &str) -> &mut Self {
        self.type_def.doc(docs);
        self
    }

    /// Add an associated type. Returns a mutable reference to the new
    /// associated type for futher configuration.
    /// 
    /// # Arguments
    /// 
    /// * `name` - The name of the associated type.
    /// 
    /// # Examples
    /// 
    /// ```
    /// use rust_codegen::Trait;
    /// 
    /// let mut foo_trait = Trait::new("Foo");
    /// foo_trait.associated_type("A");
    /// ```
    pub fn associated_type(&mut self, name: &str) -> &mut AssociatedType {
        self.associated_tys.push(AssociatedType(Bound {
            name: name.to_string(),
            bound: vec![],
        }));

        self.associated_tys.last_mut().unwrap()
    }

    /// Push a new function definition, returning a mutable reference to it.
    /// 
    /// # Arguments
    /// 
    /// * `name` - The name of the function.
    /// 
    /// # Examples
    /// 
    /// ```
    /// use rust_codegen::Trait;
    /// 
    /// let mut foo_trait = Trait::new("Foo");
    /// foo_trait.new_fn("bar_fn");
    /// ```
    pub fn new_fn(&mut self, name: &str) -> &mut Function {
        let mut func = Function::new(name);
        func.body = None;

        self.push_fn(func);
        self.fns.last_mut().unwrap()
    }

    /// Push a function definition.
    /// 
    /// # Arguments
    /// 
    /// * `item` - The function to add.
    /// 
    /// # Examples
    /// 
    /// ```
    /// use rust_codegen::{Function,Trait};
    /// 
    /// let mut foo_trait = Trait::new("Foo");
    /// let mut bar_fn = Function::new("bar_fn");
    /// 
    /// foo_trait.push_fn(bar_fn);
    /// ```
    pub fn push_fn(&mut self, item: Function) -> &mut Self {
        self.fns.push(item);
        self
    }

    /// Formats the scope using the given formatter.
    /// 
    /// # Arguments
    /// 
    /// * `fmt` - The formatter to use.
    /// 
    /// # Examples
    /// 
    /// ```
    /// use rust_codegen::{Formatter,Trait};
    /// 
    /// let mut dest = String::new();
    /// let mut fmt = Formatter::new(&mut dest);
    /// 
    /// let mut foo_trait = Trait::new("Foo");
    /// foo_trait.fmt(&mut fmt);
    /// ```
    pub fn fmt(&self, fmt: &mut Formatter<'_>) -> fmt::Result {
        self.type_def.fmt_head("trait", &self.parents, fmt)?;

        fmt.block(|fmt| {
            let assoc = &self.associated_tys;

            // format associated types
            if !assoc.is_empty() {
                for ty in assoc {
                    let ty = &ty.0;

                    write!(fmt, "type {}", ty.name)?;

                    if !ty.bound.is_empty() {
                        write!(fmt, ": ")?;
                        fmt_bound_rhs(&ty.bound, fmt)?;
                    }

                    write!(fmt, ";\n")?;
                }
            }

            for (i, func) in self.fns.iter().enumerate() {
                if i != 0 || !assoc.is_empty() {
                    write!(fmt, "\n")?;
                }

                func.fmt(true, fmt)?;
            }

            Ok(())
        })
    }
}