xee-name 0.1.5

Xee XML namespace support
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

use ahash::{HashMap, HashMapExt};
use std::sync::LazyLock;

/// The XPath FN namespace URI
pub const FN_NAMESPACE: &str = "http://www.w3.org/2005/xpath-functions";
/// The XML Schema XS namespace URI
pub const XS_NAMESPACE: &str = "http://www.w3.org/2001/XMLSchema";
const XML_NAMESPACE: &str = "http://www.w3.org/XML/1998/namespace";

const STATIC_NAMESPACES: [(&str, &str); 7] = [
    ("xs", XS_NAMESPACE),
    ("fn", FN_NAMESPACE),
    ("math", "http://www.w3.org/2005/xpath-functions/math"),
    ("map", "http://www.w3.org/2005/xpath-functions/map"),
    ("array", "http://www.w3.org/2005/xpath-functions/array"),
    ("err", "http://www.w3.org/2005/xqt-errors"),
    ("output", "http://www.w3.org/2010/xslt-xquery-serialization"),
];

/// Static default namespaces.
pub static DEFAULT_NAMESPACES: LazyLock<Namespaces> = LazyLock::new(|| Default::default());

/// Declared namespaces.
#[derive(Debug, Clone)]
pub struct Namespaces {
    namespaces: HashMap<String, String>,
    /// The default namespace for elements in XPath expressions.
    pub default_element_namespace: String,
    /// The default namespace for functions in XPath expressions.
    pub default_function_namespace: String,
}

impl Namespaces {
    /// The XPath FN namespace URI
    pub const FN_NAMESPACE: &'static str = FN_NAMESPACE;

    /// Create a new namespace struct.
    pub fn new(
        namespaces: HashMap<String, String>,
        default_element_namespace: String,
        default_function_namespace: String,
    ) -> Self {
        Self {
            namespaces,
            default_element_namespace,
            default_function_namespace,
        }
    }

    /// The default known namespaces for XPath.
    pub fn default_namespaces() -> HashMap<String, String> {
        let mut namespaces = HashMap::new();
        namespaces.insert("xml".to_string(), XML_NAMESPACE.to_string());
        for (prefix, uri) in STATIC_NAMESPACES.into_iter() {
            namespaces.insert(prefix.to_string(), uri.to_string());
        }
        namespaces
    }

    /// Add a list of namespace declarations (prefix, uri) to the namespace
    /// store.
    pub fn add(&mut self, namespace_pairs: &[(&str, &str)]) {
        for (prefix, namespace) in namespace_pairs {
            if prefix.is_empty() {
                self.default_element_namespace = namespace.to_string();
            } else {
                self.namespaces
                    .insert(prefix.to_string(), namespace.to_string());
            }
        }
    }

    /// Get the namespace URI for a given prefix.
    #[inline]
    pub fn by_prefix(&self, prefix: &str) -> Option<&str> {
        self.namespaces.get(prefix).map(String::as_str)
    }

    /// Get the default element namespace.
    #[inline]
    pub fn default_element_namespace(&self) -> &str {
        self.default_element_namespace.as_str()
    }
}

impl Default for Namespaces {
    fn default() -> Self {
        Self::new(
            Self::default_namespaces(),
            "".to_string(),
            FN_NAMESPACE.to_string(),
        )
    }
}

/// A trait for looking up namespace URIs by prefix.
pub trait NamespaceLookup {
    /// Get the namespace URI for a given prefix.
    fn by_prefix(&self, prefix: &str) -> Option<&str>;
}

impl NamespaceLookup for Namespaces {
    fn by_prefix(&self, prefix: &str) -> Option<&str> {
        self.namespaces.get(prefix).map(String::as_str)
    }
}

impl<T: NamespaceLookup> NamespaceLookup for &T {
    fn by_prefix(&self, prefix: &str) -> Option<&str> {
        (**self).by_prefix(prefix)
    }
}