analysis: Introduce Vulkan XML parser

Author: Friz64

.github/workflows/ci.yml

@@ -42,6 +42,9 @@ jobs:
       - name: Install Vulkan loader
         run: sudo apt-get install libvulkan-dev
       - uses: actions/checkout@v4
+      - name: Checkout submodule
+        # Manually update submodules with --checkout because they are configured with update=none and will be skipped otherwise
+        run: git submodule update --recursive --init --force --checkout
       - name: Test all targets
         run: cargo test --workspace --all-targets
       - name: Test docs

analysis/Cargo.toml

@@ -4,3 +4,5 @@ version = "2.0.0"
 edition = "2021"
 
 [dependencies]
+roxmltree = "0.19"
+tracing = "0.1"

analysis/src/lib.rs

@@ -1,9 +1,38 @@
-use std::path::Path;
+mod xml;
 
-pub struct Analysis {}
+use std::{fs, path::Path};
+use tracing::{debug, error_span};
+
+#[derive(Debug)]
+pub struct Analysis {
+    pub vk: Library,
+    pub video: Library,
+}
 
 impl Analysis {
-    pub fn new(_vulkan_headers_path: impl AsRef<Path>) -> Analysis {
-        Analysis {}
+    pub fn new(vulkan_headers_path: impl AsRef<Path>) -> Analysis {
+        let vulkan_headers_path = vulkan_headers_path.as_ref();
+        Analysis {
+            vk: Library::new(vulkan_headers_path.join("registry/vk.xml")),
+            video: Library::new(vulkan_headers_path.join("registry/video.xml")),
+        }
+    }
+}
+
+#[derive(Debug)]
+pub struct Library {
+    _xml: xml::Registry,
+}
+
+impl Library {
+    fn new(xml_path: impl AsRef<Path>) -> Library {
+        let xml = error_span!("xml", path = %xml_path.as_ref().display()).in_scope(|| {
+            // We leak the input string here for convenience, to avoid explicit lifetimes.
+            let xml_input = Box::leak(fs::read_to_string(xml_path).unwrap().into_boxed_str());
+            debug!("parsing xml");
+            xml::Registry::parse(xml_input, "vulkan")
+        });
+
+        Library { _xml: xml }
     }
 }