sigil-stitch 0.3.0

Type-safe, import-aware, width-aware code generation for multiple languages
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

use sigil_stitch::code_block::CodeBlock;
use sigil_stitch::lang::cpp_lang::CppLang;
use sigil_stitch::spec::file_spec::FileSpec;
use sigil_stitch::spec::fun_spec::FunSpec;
use sigil_stitch::spec::parameter_spec::ParameterSpec;
use sigil_stitch::type_name::TypeName;

use super::golden;

#[test]
fn test_const_method() {
    let fun = FunSpec::builder("size")
        .returns(TypeName::primitive("int"))
        .suffix("const")
        .suffix("noexcept")
        .build()
        .unwrap();

    let file = FileSpec::builder_with("api.hpp", CppLang::header())
        .add_function(fun)
        .build()
        .unwrap();
    let output = file.render(80).unwrap();

    golden::assert_golden("cpp/const_method.cpp", &output);
}

#[test]
fn test_template_function() {
    let body = CodeBlock::of("return (a > b) ? a : b;", ()).unwrap();
    let fun = FunSpec::builder("max_of")
        .annotation(CodeBlock::of("template<typename T>", ()).unwrap())
        .add_param(ParameterSpec::new("a", TypeName::primitive("const T&")).unwrap())
        .add_param(ParameterSpec::new("b", TypeName::primitive("const T&")).unwrap())
        .returns(TypeName::primitive("T"))
        .body(body)
        .build()
        .unwrap();

    let file = FileSpec::builder_with("algo.hpp", CppLang::header())
        .add_function(fun)
        .build()
        .unwrap();
    let output = file.render(80).unwrap();

    golden::assert_golden("cpp/template_function.cpp", &output);
}

#[test]
fn test_static_method() {
    let body = CodeBlock::of("return instance_count_;", ()).unwrap();
    let fun = FunSpec::builder("count")
        .is_static()
        .returns(TypeName::primitive("int"))
        .body(body)
        .build()
        .unwrap();

    let file = FileSpec::builder_with("helpers.cpp", CppLang::new())
        .add_function(fun)
        .build()
        .unwrap();
    let output = file.render(80).unwrap();

    golden::assert_golden("cpp/static_method.cpp", &output);
}

#[test]
fn test_function_with_doc() {
    let body = CodeBlock::of("return (a > b) ? a : b;", ()).unwrap();
    let fun = FunSpec::builder("max_val")
        .doc("Return the larger of two values.")
        .add_param(ParameterSpec::new("a", TypeName::primitive("int")).unwrap())
        .add_param(ParameterSpec::new("b", TypeName::primitive("int")).unwrap())
        .returns(TypeName::primitive("int"))
        .body(body)
        .build()
        .unwrap();

    let file = FileSpec::builder_with("math_doc.cpp", CppLang::new())
        .add_function(fun)
        .build()
        .unwrap();
    let output = file.render(80).unwrap();

    golden::assert_golden("cpp/function_with_doc.cpp", &output);
}