zamm_yang 0.0.10

A basic, experimental code generator
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

/// Mark files as autogenerated.
pub mod mark_autogen;
/// Mark lines as not needing formatting.
///
/// Sometimes, it's just too hard to autogenerate perfectly formatted code.
pub mod mark_fmt;

use super::CodegenConfig;
use mark_autogen::add_autogeneration_comments;
use mark_fmt::add_fmt_skips;

/// Do post-processing on generated code. Includes marking lines with autogeneration comments, or
/// marking lines as requiring formatting skips.
pub fn post_process_generation(code: &str, options: &CodegenConfig) -> String {
    let formatted = add_fmt_skips(&code);
    if options.comment_autogen && !options.release {
        add_autogeneration_comments(&formatted)
    } else {
        formatted
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::codegen::string_format::tao::code_tao;
    use crate::codegen::string_format::FormatConfig;
    use crate::codegen::CodeConfig;
    use mark_autogen::AUTOGENERATION_MARKER;
    use mark_fmt::FMT_SKIP_MARKER;
    use std::rc::Rc;

    #[test]
    fn test_post_process_comments() {
        let code = code_tao(&FormatConfig::default());
        let result = post_process_generation(&code, &CodegenConfig::default());
        assert!(result.contains(AUTOGENERATION_MARKER));
        assert!(result.contains("YIN_MAX_ID"));
    }

    #[test]
    fn test_post_process_no_comments() {
        let code_cfg = &CodeConfig {
            codegen_cfg: CodegenConfig {
                comment_autogen: false,
                ..CodegenConfig::default()
            },
            ..CodeConfig::default()
        };
        let code = code_tao(&FormatConfig::from(code_cfg));
        let result = post_process_generation(&code, &code_cfg.codegen_cfg);
        assert!(!result.contains(AUTOGENERATION_MARKER));
    }

    #[test]
    fn test_post_process_yin() {
        let code_cfg = &CodeConfig {
            codegen_cfg: CodegenConfig {
                yin: true,
                ..CodegenConfig::default()
            },
            ..CodeConfig::default()
        };
        let code = code_tao(&FormatConfig::from(code_cfg));
        let result = post_process_generation(&code, &code_cfg.codegen_cfg);
        assert!(!result.contains("YIN_MAX_ID"));
    }

    #[test]
    fn test_post_process_fmt_not_skip() {
        let code_cfg = &CodeConfig {
            name: Rc::new("S".to_owned()), // short
            ..CodeConfig::default()
        };
        let code = code_tao(&FormatConfig::from(code_cfg));
        let result = post_process_generation(&code, &code_cfg.codegen_cfg);
        assert!(!result.contains(FMT_SKIP_MARKER));
    }

    #[test]
    fn test_post_process_fmt_skip() {
        let code_cfg = &CodeConfig {
            name: Rc::new("ReallySuperLongClassNameOhBoy".to_owned()),
            codegen_cfg: CodegenConfig {
                release: false,
                ..CodegenConfig::default()
            },
            ..CodeConfig::default()
        };
        let code = code_tao(&FormatConfig::from(code_cfg));
        let result = post_process_generation(&code, &code_cfg.codegen_cfg);
        assert!(result.contains(FMT_SKIP_MARKER));
    }

    #[test]
    fn test_post_process_fmt_skip_release() {
        let code_cfg = &CodeConfig {
            name: Rc::new("ReallySuperLongClassNameOhBoy".to_owned()),
            codegen_cfg: CodegenConfig {
                release: true,
                ..CodegenConfig::default()
            },
            ..CodeConfig::default()
        };
        let code = code_tao(&FormatConfig::from(code_cfg));
        let result = post_process_generation(&code, &code_cfg.codegen_cfg);
        assert!(result.contains(FMT_SKIP_MARKER));
    }
}