wgsldoc 1.0.1

Documentation generator for WGSL shaders
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

use fs_err as fs;
use std::path::PathBuf;
use wgsldoc::parser::WgslParser;
use wgsldoc::Document;

#[test]
fn test_parse_invalid_syntax() {
    let shader_code = "fn invalid syntax here";
    let result = WgslParser::parse("test", shader_code);
    assert!(result.is_err());
}

#[test]
fn test_parse_unclosed_struct() {
    let shader_code = r#"
struct Point {
    x: f32,
    y: f32
"#;
    let result = WgslParser::parse("test", shader_code);
    assert!(result.is_err());
}

#[test]
fn test_parse_invalid_type() {
    let shader_code = r#"
struct Point {
    x: invalid_type,
}
"#;
    let result = WgslParser::parse("test", shader_code);
    assert!(result.is_ok());
}

#[test]
fn test_parse_empty_function_no_body() {
    let shader_code = "fn test()";
    let result = WgslParser::parse("test", shader_code);
    assert!(result.is_err());
}

#[test]
fn test_parse_duplicate_structure_names() {
    let shader_code = r#"
struct Point {
    x: f32,
}

struct Point {
    y: f32,
}
"#;
    let result = WgslParser::parse("test", shader_code);
    assert!(result.is_ok());

    let shader = result.unwrap();
    assert_eq!(shader.structures.len(), 1);
}

#[test]
fn test_parse_duplicate_function_names() {
    let shader_code = r#"
fn test() {
    return;
}

fn test() {
    return;
}
"#;
    let result = WgslParser::parse("test", shader_code);
    assert!(result.is_ok());

    let shader = result.unwrap();
    assert_eq!(shader.functions.len(), 1);
}

#[test]
fn test_document_nonexistent_directory() {
    let result = Document::open("test", "/nonexistent/directory/path");
    assert!(result.is_err());
}

#[test]
fn test_document_invalid_wgsl_file() {
    use tempfile::TempDir;

    let temp_dir = TempDir::new().unwrap();
    let shader_path = temp_dir.path().join("invalid.wgsl");

    fs::write(&shader_path, "this is not valid WGSL syntax {{{{").unwrap();

    let result = Document::open("test_project", temp_dir.path());
    assert!(result.is_err());
}

#[test]
fn test_parse_function_missing_return_type_arrow() {
    let shader_code = r#"
fn test() f32 {
    return 0.0;
}
"#;
    let result = WgslParser::parse("test", shader_code);
    assert!(result.is_err());
}

#[test]
fn test_parse_struct_missing_field_type() {
    let shader_code = r#"
struct Point {
    x,
}
"#;
    let result = WgslParser::parse("test", shader_code);
    assert!(result.is_err());
}

#[test]
fn test_parse_nested_braces() {
    let shader_code = r#"
fn complex() {
    if (true) {
        if (false) {
            let x = 5;
        }
    }
}
"#;
    let result = WgslParser::parse("test", shader_code);
    assert!(result.is_ok());
}

#[test]
fn test_parse_comments_not_docs() {
    let shader_code = r#"
// This is a regular comment, not documentation
fn test() {}
"#;
    let result = WgslParser::parse("test", shader_code);
    assert!(result.is_ok());

    let shader = result.unwrap();
    assert!(shader.functions[0].docs().is_none());
}

#[test]
fn test_parse_mixed_documentation() {
    let shader_code = r#"
//! Global docs
// Regular comment
/// Function docs
fn test() {}
"#;
    let result = WgslParser::parse("test", shader_code);
    assert!(result.is_ok());

    let shader = result.unwrap();
    assert!(shader.global_docs.is_some());
    assert!(shader.functions[0].docs().is_some());
}

#[test]
fn test_document_with_empty_paths() {
    let result = Document::new("test", &[] as &[PathBuf]);
    assert!(result.is_ok());
}