fix(vulkan): ensure we use the proper spec name in the generated file

Signed-off-by: Steven Noonan <steven@uplinklabs.net>

Author: tycho

src/cli.rs

@@ -129,17 +129,30 @@ impl Cli {
 
 /// Normalize an API name to its canonical short form.
 ///
-/// The Khronos XML uses `"vulkan"` in feature and extension `api=`
-/// / `supported=` attributes, but the CLI convention is `"vk"`.  This function
-/// maps the long form to the short form so the rest of the codebase can use
-/// a single canonical name.  All other API names pass through unchanged.
+/// The Khronos XML uses `"vulkan"` in feature and extension `api=` / `supported=`
+/// attributes, but the CLI convention (and GLAD's convention) is `"vk"`.  This
+/// function maps the long form to the short form so the rest of the codebase
+/// can use a single canonical name.  All other API names pass through unchanged.
 pub fn canonical_api_name(name: &str) -> &str {
     match name {
         "vulkan" => "vk",
         other => other,
     }
 }
 
+/// Map a canonical short API name back to the XML-canonical form.
+///
+/// Used when the name will appear in generated symbol names (e.g.
+/// `kExtIdx_vulkan`, `gloam_vk_find_extensions_vulkan`), where the XML
+/// convention is the appropriate one.  `spec_name` ("vk") controls file
+/// stems; this controls symbol suffixes.
+pub fn xml_api_name(name: &str) -> &str {
+    match name {
+        "vk" => "vulkan",
+        other => other,
+    }
+}
+
 /// One parsed entry from the `--api` argument.
 #[derive(Debug, Clone)]
 pub struct ApiRequest {

src/resolve.rs

@@ -10,7 +10,7 @@ use anyhow::Result;
 use indexmap::IndexMap;
 use serde::Serialize;
 
-use crate::cli::{ApiRequest, Cli, canonical_api_name};
+use crate::cli::{ApiRequest, Cli, canonical_api_name, xml_api_name};
 use crate::fetch;
 use crate::ir::{RawCommand, RawSpec};
 use crate::parse;
@@ -335,7 +335,14 @@ fn resolve_feature_set(
         _ => spec_name.as_str(),
     };
 
-    let api_names: Vec<String> = requests.iter().map(|r| r.name.clone()).collect();
+    // api_names uses the XML-canonical form ("vulkan" not "vk") because
+    // these flow into generated C symbol suffixes (kExtIdx_vulkan, etc.)
+    // and IndexMap keys used by the templates.  File stems come from
+    // spec_name ("vk"), not from here.
+    let api_names: Vec<String> = requests
+        .iter()
+        .map(|r| xml_api_name(&r.name).to_string())
+        .collect();
 
     // ------------------------------------------------------------------
     // Step 1: Determine which features (versions) are selected.

tests/generate_vulkan.rs

@@ -111,7 +111,7 @@ fn vulkan_13_generates_expected_files() {
         .assert()
         .success();
 
-    assert_c_output_exists(dir.path(), "vk");
+    assert_c_output_exists(dir.path(), "vulkan");
     try_compile_c(dir.path());
 }
 
@@ -130,7 +130,7 @@ fn vulkan_13_with_loader_generates_and_compiles() {
         .assert()
         .success();
 
-    assert_c_output_exists(dir.path(), "vk");
+    assert_c_output_exists(dir.path(), "vulkan");
     try_compile_c(dir.path());
 }
 
@@ -149,7 +149,7 @@ fn vulkan_13_with_alias_generates_and_compiles() {
         .assert()
         .success();
 
-    assert_c_output_exists(dir.path(), "vk");
+    assert_c_output_exists(dir.path(), "vulkan");
     try_compile_c(dir.path());
 }
 
@@ -169,7 +169,7 @@ fn vulkan_13_all_flags_generates_and_compiles() {
         .assert()
         .success();
 
-    assert_c_output_exists(dir.path(), "vk");
+    assert_c_output_exists(dir.path(), "vulkan");
     try_compile_c(dir.path());
 }
 
@@ -180,15 +180,15 @@ fn vulkan_latest_version_generates() {
     gloam()
         .args([
             "--api",
-            "vk",
+            "vulkan",
             "--out-path",
             dir.path().to_str().unwrap(),
             "c",
         ])
         .assert()
         .success();
 
-    assert_c_output_exists(dir.path(), "vk");
+    assert_c_output_exists(dir.path(), "vulkan");
     try_compile_c(dir.path());
 }
 
@@ -208,7 +208,7 @@ fn vulkan_long_name_normalizes_to_vk_stem() {
         .assert()
         .success();
 
-    assert_c_output_exists(dir.path(), "vk");
+    assert_c_output_exists(dir.path(), "vulkan");
     try_compile_c(dir.path());
 }
 
@@ -230,7 +230,7 @@ fn vulkan_header_has_context_and_scope_enum() {
         .assert()
         .success();
 
-    let header = read_header(dir.path(), "vk");
+    let header = read_header(dir.path(), "vulkan");
 
     assert!(
         header.contains("GloamVulkanContext"),
@@ -266,7 +266,7 @@ fn vulkan_header_has_core_commands() {
         .assert()
         .success();
 
-    let header = read_header(dir.path(), "vk");
+    let header = read_header(dir.path(), "vulkan");
 
     // Fundamental Vulkan entry points that must always be present.
     assert!(
@@ -303,7 +303,7 @@ fn vulkan_header_has_version_macros() {
         .assert()
         .success();
 
-    let header = read_header(dir.path(), "vk");
+    let header = read_header(dir.path(), "vulkan");
 
     assert!(
         header.contains("VK_VERSION_1_0 1"),
@@ -339,7 +339,7 @@ fn vulkan_10_does_not_have_13_features() {
         .assert()
         .success();
 
-    let header = read_header(dir.path(), "vk");
+    let header = read_header(dir.path(), "vulkan");
 
     assert!(
         header.contains("VK_VERSION_1_0 1"),
@@ -372,7 +372,7 @@ fn vulkan_with_extension_filter_generates() {
         .assert()
         .success();
 
-    let header = read_header(dir.path(), "vk");
+    let header = read_header(dir.path(), "vulkan");
     assert!(
         header.contains("KHR_swapchain"),
         "VK_KHR_swapchain should be present when explicitly requested"