gloam 0.1.4

//! Parsing of `<feature>` and `<extension>` elements.

use anyhow::Result;
use indexmap::IndexMap;

use super::SpecDocs;
use crate::ir::{RawExtension, RawFeature, Remove, Require};

// GLX extensions with unresolvable type dependencies (spec gotcha #8).
const BROKEN_GLX_EXTENSIONS: &[&str] = &["GLX_SGIX_video_source", "GLX_SGIX_dmbuffer"];

// WGL extensions that must always be present (spec gotcha #9).
const WGL_MANDATORY_EXTENSIONS: &[&str] =
    &["WGL_ARB_extensions_string", "WGL_EXT_extensions_string"];

// ---------------------------------------------------------------------------
// Public entry point
// ---------------------------------------------------------------------------

pub fn parse_features_extensions(
    docs: &SpecDocs<'_, '_>,
    spec_name: &str,
    platforms: &IndexMap<String, String>,
) -> Result<(Vec<RawFeature>, Vec<RawExtension>)> {
    let features = parse_features(docs, spec_name)?;
    let extensions = parse_extensions(docs, spec_name, platforms)?;
    Ok((features, extensions))
}

// ---------------------------------------------------------------------------
// Features
// ---------------------------------------------------------------------------

fn parse_features(docs: &SpecDocs<'_, '_>, _spec_name: &str) -> Result<Vec<RawFeature>> {
    let mut features: Vec<RawFeature> = Vec::new();

    // --- Pass 1: collect all public (non-internal) features ---
    for node in docs.all_features() {
        let api_type = node.attribute("apitype");
        let is_internal = api_type == Some("internal");
        if is_internal {
            continue;
        }

        let name = match node.attribute("name") {
            Some(n) => n.to_string(),
            None => continue,
        };
        let api_raw = match node.attribute("api") {
            Some(a) => a,
            None => continue,
        };
        let version_str = match node.attribute("number") {
            Some(v) => v,
            None => continue,
        };
        let version = match super::parse_version(version_str) {
            Ok(v) => v,
            Err(_) => continue,
        };

        let requires = node
            .children()
            .filter(|n| n.is_element() && n.tag_name().name() == "require")
            .map(parse_require)
            .collect::<Vec<_>>();
        let removes = node
            .children()
            .filter(|n| n.is_element() && n.tag_name().name() == "remove")
            .map(parse_remove)
            .collect::<Vec<_>>();

        // A feature may list multiple APIs (comma-separated).
        for api in api_raw.split(',') {
            let api = api.trim().to_string();
            features.push(RawFeature {
                name: name.clone(),
                api: api.clone(),
                version: version.clone(),
                requires: requires.clone(),
                removes: removes.clone(),
            });
        }
    }

    // --- Pass 2: merge internal feature require blocks into matching public
    // features (same api + version).  This mirrors what GLAD's parse.py and
    // Khronos's reg.py do — internal features (apitype="internal") partition
    // the API for VulkanBase bookkeeping but their requirements belong to the
    // public API.  We must do this as a second pass because internal features
    // can appear before their corresponding public feature in the XML, so a
    // single-pass approach silently drops the merge when the public feature
    // hasn't been pushed yet.
    for node in docs.all_features() {
        let api_type = node.attribute("apitype");
        let is_internal = api_type == Some("internal");
        if !is_internal {
            continue;
        }

        let api_raw = match node.attribute("api") {
            Some(a) => a,
            None => continue,
        };
        let version_str = match node.attribute("number") {
            Some(v) => v,
            None => continue,
        };
        let version = match super::parse_version(version_str) {
            Ok(v) => v,
            Err(_) => continue,
        };

        let extra_requires: Vec<_> = node
            .children()
            .filter(|n| n.is_element() && n.tag_name().name() == "require")
            .map(parse_require)
            .collect();

        for api in api_raw.split(',') {
            let api = api.trim();
            if let Some(public) = features
                .iter_mut()
                .find(|f| f.api == api && f.version == version)
            {
                public.requires.extend(extra_requires.clone());
            }
            // No match means this api/version isn't selected — that's fine.
        }
    }

    // Sort: by api lexicographically, then by ascending version.
    features.sort_by(|a, b| a.api.cmp(&b.api).then_with(|| a.version.cmp(&b.version)));

    Ok(features)
}

// ---------------------------------------------------------------------------
// Extensions
// ---------------------------------------------------------------------------

fn parse_extensions(
    docs: &SpecDocs<'_, '_>,
    spec_name: &str,
    platforms: &IndexMap<String, String>,
) -> Result<Vec<RawExtension>> {
    let mut extensions: Vec<RawExtension> = Vec::new();
    let mut seen_names = std::collections::HashSet::new();

    for node in docs.all_extensions() {
        if node.tag_name().name() != "extension" {
            continue;
        }

        let name = match node.attribute("name") {
            Some(n) => n.to_string(),
            None => continue,
        };

        // Spec gotcha #8: silently drop broken GLX extensions.
        if spec_name == "glx" && BROKEN_GLX_EXTENSIONS.contains(&name.as_str()) {
            eprintln!("warning: dropping broken GLX extension '{}'", name);
            continue;
        }

        // Dedup by name (supplemental XMLs may re-declare extensions).
        if !seen_names.insert(name.clone()) {
            continue;
        }

        // `supported` uses `|` in GL and `,` in Vulkan.
        let supported_raw = node.attribute("supported").unwrap_or("disabled");
        let supported: Vec<String> = supported_raw
            .replace('|', ",")
            .split(',')
            .map(str::trim)
            .filter(|s| !s.is_empty() && *s != "disabled")
            .map(str::to_string)
            .collect();

        if supported.is_empty() {
            continue;
        }

        // Resolve protection: explicit `protect=` wins; otherwise look up
        // `platform=` in the platforms registry.
        let mut protect: Vec<String> = node
            .attribute("protect")
            .unwrap_or("")
            .split(',')
            .map(str::trim)
            .filter(|s| !s.is_empty())
            .map(str::to_string)
            .collect();

        if protect.is_empty()
            && let Some(platform) = node.attribute("platform")
            && let Some(p) = platforms.get(platform)
        {
            protect.push(p.clone());
        }

        let number = node.attribute("number").and_then(|s| s.parse().ok());

        let requires = node
            .children()
            .filter(|n| n.is_element() && n.tag_name().name() == "require")
            .map(parse_require)
            .collect::<Vec<_>>();

        extensions.push(RawExtension {
            name,
            supported,
            requires,
            protect,
            number,
        });
    }

    // Spec gotcha #9: WGL mandatory extensions.
    if spec_name == "wgl" {
        for &mandatory in WGL_MANDATORY_EXTENSIONS {
            if !extensions.iter().any(|e| e.name == mandatory) {
                eprintln!(
                    "warning: WGL mandatory extension '{}'  not found in spec",
                    mandatory
                );
            }
        }
    }

    Ok(extensions)
}
// ---------------------------------------------------------------------------
// Parse <require> and <remove> blocks
// ---------------------------------------------------------------------------

fn parse_require(node: roxmltree::Node<'_, '_>) -> Require {
    let api = node.attribute("api").map(str::to_string);
    let profile = node.attribute("profile").map(str::to_string);

    let mut req = Require {
        api,
        profile,
        ..Default::default()
    };

    for child in node.children().filter(|n| n.is_element()) {
        let tag = child.tag_name().name();
        let name = child.attribute("name").unwrap_or("").to_string();
        if name.is_empty() {
            continue;
        }
        // Skip extending-enum entries here; they are handled separately in
        // enums.rs to avoid double-counting.
        if tag == "enum" && child.attribute("extends").is_some() {
            continue;
        }
        match tag {
            "type" => req.types.push(name),
            "enum" => req.enums.push(name),
            "command" => req.commands.push(name),
            _ => {}
        }
    }

    req
}

fn parse_remove(node: roxmltree::Node<'_, '_>) -> Remove {
    let profile = node.attribute("profile").map(str::to_string);
    let mut rem = Remove {
        profile,
        ..Default::default()
    };

    for child in node.children().filter(|n| n.is_element()) {
        let name = child.attribute("name").unwrap_or("").to_string();
        if name.is_empty() {
            continue;
        }
        match child.tag_name().name() {
            "command" => rem.commands.push(name),
            "enum" => rem.enums.push(name),
            _ => {}
        }
    }

    rem
}