vulkan_gen 0.2.0

Vulkan XML specification parser and Rust binding generator. Used internally by the vulkane crate, but reusable as a standalone 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

//! Utilities for emitting provisional (stub) types during code generation.

use std::fs::OpenOptions;
use std::io::Write;
use std::path::Path;

/// The kind of provisional type to emit.
pub enum ProvisionalKind {
    Struct,
    Handle,
    Enum,
    Alias,
    Basic,
}

/// Emit a provisional type stub to the provisional_types.rs file.
pub fn emit_provisional_type(name: &str, kind: ProvisionalKind, out_dir: &Path) {
    let file_path = out_dir.join("provisional_types.rs");
    let mut file = OpenOptions::new()
        .create(true)
        .append(true)
        .open(&file_path)
        .expect("Failed to open provisional_types.rs");
    let code = match kind {
        ProvisionalKind::Struct => format!(
            "// PROVISIONAL: auto-generated stub for missing struct\npub struct {} {{ _private: () }}\n\n",
            name
        ),
        ProvisionalKind::Handle => format!(
            "// PROVISIONAL: auto-generated stub for missing handle\npub type {} = *mut std::ffi::c_void;\n\n",
            name
        ),
        ProvisionalKind::Enum => format!(
            "// PROVISIONAL: auto-generated stub for missing enum\npub enum {} {{ _Dummy }}\n\n",
            name
        ),
        ProvisionalKind::Alias => format!(
            "// PROVISIONAL: auto-generated stub for missing alias\npub type {} = ();\n\n",
            name
        ),
        ProvisionalKind::Basic => format!(
            "// PROVISIONAL: auto-generated stub for missing basic type\npub type {} = ();\n\n",
            name
        ),
    };
    file.write_all(code.as_bytes())
        .expect("Failed to write provisional type");
}