rifgen 0.1.61

ffi Interface file generator. Use with flapigen
Documentation
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
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
use crate::enums::{Delimiters, NewLineState, Types};
use crate::generator_lib::{F_CALLBACK, F_CLASS, F_ENUM};
use crate::text_formatter::StringFormatter;
use crate::TypeCases;
use derive_new::new;
use inflector::Inflector;
use std::iter::Chain;
use std::slice::Iter;

//todo: avoid static mut
pub(crate) static mut TYPE_CASE: TypeCases = TypeCases::Default;

#[derive(Debug, new)]
pub struct ItemInfo {
    ///doc for the method or variant
    pub docs: Vec<String>,
    /// could be an enum variant or a method
    pub signature: String,
    /// item type
    pub is_constructor: bool,
    ///method name to use with only methods
    ///No enums included
    pub method_info: Option<MethodInfo>,
}
#[derive(Debug, new)]

pub struct MethodInfo {
    name: String,
    types_in_method: Vec<String>,
    return_types: Vec<String>,
}

impl MethodInfo {
    pub fn all_types(&self) -> Chain<Iter<'_, String>, Iter<'_, String>> {
        self.types_in_method.iter().chain(self.return_types.iter())
    }
}

impl ItemInfo {
    ///Creates a new `ItemInfo` which is a method
    pub fn new_method(
        signature: String,
        docs: Vec<String>,
        method_name: String,
        is_constructor: bool,
        types_in_method: Vec<String>,
        return_types: Vec<String>,
    ) -> ItemInfo {
        ItemInfo::new(
            docs,
            signature,
            is_constructor,
            Some(MethodInfo::new(method_name, types_in_method, return_types)),
        )
    }

    ///Creates a new `ItemInfo` which is an enum
    pub fn new_enum(signature: String, docs: Vec<String>) -> ItemInfo {
        ItemInfo::new(docs, signature, false, None)
    }
}
///Convenient macro to add the doc comments
#[macro_export]
#[doc(hidden)]
macro_rules! add_doc {
    ($expr:expr,$formatter:expr) => {{
        $expr
            .docs
            .iter()
            .for_each(|it| $formatter.add_text_and_then_line(vec![it], NewLineState::Current));
    }};
}

///This macro is to generate the structs which would be used to hold data for various item types
/// ie Struct, Enum, Trait
#[macro_export]
#[doc(hidden)]
macro_rules! gen_structs {
    ($($name:ident),*) => {
        $(
            #[derive(Debug,new)]
            pub struct $name {
                /// Name of struct, Trait or Enum
                pub name: String,
                pub type_:Types,
                /// the doc string of this type
                pub docs: Vec<String>,
                /// the methods or variants with this type
                pub extras: Vec<ItemInfo>,
            }

            impl $name {
                pub fn generate_interface(&mut self) -> String {
                    let mut formatter = StringFormatter::new(String::with_capacity(1024), 0);
                    match self.type_ {
                        Types::Struct => self.format_struct(&mut formatter),
                        Types::Trait => self.format_trait(&mut formatter),
                        Types::Enum => {self.format_enum(&mut formatter)}
                    }
                    formatter.close_all_delimiters();
                    formatter.string_container
                }

                fn format_struct(&mut self, formatter: &mut StringFormatter) {
                    //Case where the struct has constructors
                    let constructors = {
                         let mut result = vec![];
                         let mut i = 0;
                         while i < self.extras.len() {
                             if self.extras[i].is_constructor {
                                 let val = self.extras.remove(i);
                                 result.push(val)
                             } else {
                                 i += 1;
                             }
                         }
                         result
                     };
                    let any_is_constructor = !constructors.is_empty();
                    formatter.add_text_delimiter_then_line(
                        vec![F_CLASS],
                        Delimiters::Parenthesis,
                        NewLineState::ShiftRight,
                    );
                    //Add the doc comment associated with this struct
                    add_doc!(self, formatter);
                    formatter.add_text_delimiter_then_line(
                            vec!["class ", &self.name],
                            Delimiters::Bracket,
                            NewLineState::ShiftRight,
                    );

                    if any_is_constructor {
                        formatter.add_text_and_colon(vec!["self_type ",&self.name]);
                        for constructor in constructors {
                            //add doc comment
                            formatter.add_text_and_then_line(
                                constructor.docs.iter().map(|it| it.as_str()).collect(),
                                NewLineState::Current,
                            );
                            formatter.add_text_and_colon(vec![
                                "constructor ",
                                &self.name,
                                "::",
                                &constructor.signature,
                            ])
                        }
                    }

                    for extra in &self.extras {
                        add_doc!(&extra, formatter);
                        let alias = unsafe {
                            match TYPE_CASE {
                                TypeCases::Default => String::new(),
                                TypeCases::CamelCase => (&extra.method_info).as_ref().unwrap().name.to_camel_case(),
                                TypeCases::SnakeCase => (&extra.method_info).as_ref().unwrap().name.to_snake_case(),
                            }
                        };
                        let alias = if alias.is_empty() {
                            alias
                        } else {
                            format!("; alias {}", alias)
                        };
                        formatter.add_text_and_colon(vec!["fn ", &self.name, "::", &extra.signature, &alias])
                    }
                }

                fn format_trait(&mut self, formatter: &mut StringFormatter) {
                    //println!("trait called");
                    formatter.add_text_delimiter_then_line(
                        vec![F_CALLBACK],
                        Delimiters::Parenthesis,
                        NewLineState::ShiftRight,
                    );
                    add_doc!(self, formatter);
                    formatter.add_text_delimiter_then_line(
                        vec!["callback ", &self.name],
                        Delimiters::Bracket,
                        NewLineState::ShiftRight,
                    );
                    formatter.add_text_and_colon(vec!["self_type ",&self.name]);
                    for extra in &self.extras {
                        add_doc!(extra, formatter);
                        let mut name = extra.method_info.as_ref().unwrap().name.to_string();
                        name = unsafe {
                            match TYPE_CASE {
                                TypeCases::Default => name,
                                TypeCases::CamelCase => (&name).to_camel_case(),
                                TypeCases::SnakeCase => (&name).to_snake_case(),
                            }
                        };
                        formatter.add_text_and_colon(vec![&name, " = ", &self.name, "::", &extra.signature])
                    }
                }

                fn format_enum(&mut self, formatter: &mut StringFormatter) {
                    formatter.add_text_delimiter_then_line(
                        vec![F_ENUM],
                        Delimiters::Parenthesis,
                        NewLineState::ShiftRight,
                    );
                    add_doc!(self, formatter);
                    formatter.add_text_delimiter_then_line(
                        vec!["enum ", &self.name],
                        Delimiters::Bracket,
                        NewLineState::ShiftRight,
                    );
                    for extra in &self.extras {
                        add_doc!(extra, formatter);
                        formatter.add_text_and_comma(vec![
                            &extra.signature,
                            " = ",
                            &self.name,
                            "::",
                            &extra.signature,
                        ])
                    }
                }
            }
        )*
    };
}

//Create structs to hold data for various types
gen_structs!(Struct, Enum, Trait);

//Prototype since ide doesn't provide code analysis for macros
// and it's quite difficult programming without code analysis
// just remove the backslash to use
/*#[derive(Debug, new)]
struct TraitTest {
    /// The name of the method or variant as it is in the source code
    name: String,
    type_: Types,
    /// the doc string of this type
    docs: Vec<String>,
    /// the methods or variants with this type
    extras: Vec<ItemInfo>,
}

impl TraitTest {
    ///Convert the info held by this struct
    pub fn generate_interface(&mut self) -> String {
        let mut formatter = StringFormatter::new(String::with_capacity(1024), 0);
        match self.type_ {
            Types::Struct => self.format_struct(&mut formatter),
            Types::Trait => self.format_trait(&mut formatter),
            Types::Enum => self.format_enum(&mut formatter),
        }
        formatter.close_all_delimiters();
        formatter.string_container
    }

    fn format_struct(&mut self, formatter: &mut StringFormatter) {
        //Case where the struct has constructors
        let constructors = self
            .extras
            .drain_filter(|it| it.is_constructor)
            .collect::<Vec<ItemInfo>>();
        let any_is_constructor = !constructors.is_empty();
        formatter.add_text_delimiter_then_line(
            vec![F_CLASS],
            Delimiters::Parenthesis,
            NewLineState::ShiftRight,
        );
        //Add the doc comment associated with this struct
        add_doc!(self, formatter);

        formatter.add_text_delimiter_then_line(
            vec!["class ", &self.name],
            Delimiters::Bracket,
            NewLineState::ShiftRight,
        );
        println!("current {}",formatter.string_container);
        if any_is_constructor {
            formatter.add_text_and_colon(vec!["self_type ",&self.name]);
            for constructor in constructors {
                //add doc comment
                formatter.add_text_and_then_line(
                    constructor.docs.iter().map(|it| it.as_str()).collect(),
                    NewLineState::Current,
                );
                formatter.add_text_and_colon(vec![
                    "constructor ",
                    &self.name,
                    "::",
                    &constructor.signature,
                ])
            }
        }

        for extra in &self.extras {
            add_doc!(&extra, formatter);
            let alias = unsafe {
                match TYPE_CASE {
                    TypeCases::Default => String::new(),
                    TypeCases::CamelCase => {
                        (&extra.method_info).as_ref().unwrap().name.to_camel_case()
                    }
                    TypeCases::SnakeCase => {
                        (&extra.method_info).as_ref().unwrap().name.to_snake_case()
                    }
                }
            };
            let alias = if alias.is_empty() {
                alias
            } else {
                format!("; alias {}", alias)
            };
            formatter.add_text_and_colon(vec!["fn ", &self.name, "::", &extra.signature, &alias])
        }
    }

    fn format_trait(&mut self, formatter: &mut StringFormatter) {
        formatter.add_text_delimiter_then_line(
            vec![F_CALLBACK],
            Delimiters::Parenthesis,
            NewLineState::ShiftRight,
        );
        add_doc!(self, formatter);
        formatter.add_text_delimiter_then_line(
            vec!["callback ", &self.name],
            Delimiters::Bracket,
            NewLineState::ShiftRight,
        );
        formatter.add_text_and_colon(vec!["self_type ",&self.name]);
        for extra in &self.extras {
            add_doc!(extra, formatter);
            let mut name = extra.method_info.as_ref().unwrap().name.to_string();
            name = unsafe {
                match TYPE_CASE {
                    TypeCases::Default => name,
                    TypeCases::CamelCase => (&name).to_camel_case(),
                    TypeCases::SnakeCase => (&name).to_snake_case(),
                }
            };
            formatter.add_text_and_colon(vec![&name, " = ", &self.name, "::", &extra.signature])
        }
    }

    fn format_enum(&mut self, formatter: &mut StringFormatter) {
        formatter.add_text_delimiter_then_line(
            vec![F_ENUM],
            Delimiters::Parenthesis,
            NewLineState::ShiftRight,
        );
        add_doc!(self, formatter);
        formatter.add_text_delimiter_then_line(
            vec!["enum ", &self.name],
            Delimiters::Bracket,
            NewLineState::ShiftRight,
        );
        for extra in &self.extras {
            add_doc!(extra, formatter);
            formatter.add_text_and_comma(vec![
                &extra.signature,
                " = ",
                &self.name,
                "::",
                &extra.signature,
            ])
        }
    }
}
*//*
todo!()
#[cfg(test)]
mod tests {
    //use crate::enums::Types;
    use crate::types_structs::{ItemInfo};

    #[test]
    fn test_struct() {
        let items = vec![
            ItemInfo::new_method(
                "new(kkkk: i64, k: Trial) -> Kofi".to_string(),
                vec!["Construct".into()],
                String::from("new"),
                true,
                vec!["i64".into(), "Trial".into()],
                vec![],
            ),
            ItemInfo::new_method(
                "trial(s : String)->i8".into(),
                Vec::new(),
                "trial".into(),
                false,
                vec!["String".into()],
                vec![],
            ),
        ];
        /*let mut result = TraitTest::new(
            "MyClass".into(),
            Types::Struct,
            vec!["My class test".into()],
            items,
        );
        println!("{}", result.generate_interface());*/
    }

    #[test]
    fn test_trait() {
        let items = vec![
            ItemInfo::new_method(
                "trial(s : String)->i8".into(),
                Vec::new(),
                "trial".into(),
                false,
                vec![],
                vec![],
            ),
            ItemInfo::new_method(
                "kofi(s : String)->usize".into(),
                Vec::new(),
                "kofi".into(),true,
                vec![],
                vec![],
            ),
        ];
        /*let mut result = TraitTest::new(
            "MyCallback".into(),
            Types::Trait,
            vec!["My callback test".into()],
            items,
        );
        println!("{}", result.generate_interface());*/
        panic!()
    }

    #[test]
    fn test_enum() {
        //TODO
    }
}
*/