xmlity 0.0.9

A (de)serialization library for XML
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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151

/// Construct an `XmlValue` from an XML-like literal.
///
/// ```
/// # use xmlity::xml;
/// #
/// let value/*: xmlity:::value::XmlElement*/ = xml!(
///     <"root">[
///         <"child" "attribute"="value">["Text"]</"child">
///         <![CDATA["CData content"]]>
///         <?"pi-target" "instruction"?>
///         <!-- "Comment" -->
///        "Text node"
///        <"child2":"http://example.com" "attr1"="value1" "attr2"="value2">[]</"child2">
///     ]</"root">
/// );
/// ```
///
/// The macro supports the following XML constructs:
/// - Elements with attributes
/// - Text nodes
/// - CDATA sections
/// - Processing instructions
/// - Comments
/// - Sequences of children
///
/// The macro will automatically choose between an `XmlSeq` and a value-type depending on if the top-level element is a sequence or not.
/// For example, the value above is an `XmlElement` with a sequence of children, while the example below returns an `XmlSeq`:
///
/// ```
/// # use xmlity::xml;
/// #
/// let value/*: xmlity::value::XmlSeq<_>*/ = xml!(
///     <"child" "attribute"="value">["Text"]</"child">
///     <"child" "attribute"="value">["Text"]</"child">
/// );
/// ```
#[macro_export]
macro_rules! xml {
    // Hide distracting implementation details from the generated rustdoc.
    ($($xml:tt)+) => {
        $crate::xml_internal!($($xml)+)
    };
}

// Changes are fine as long as `xml_internal!` does not call any new helper
// macros and can still be invoked as `xml_internal!($($xml)+)`.
#[macro_export]
#[doc(hidden)]
macro_rules! xml_internal {
    (@childseq_wrapper [$first_seq_element:expr$(,$($seq_elements:expr),+)?] [$($wrapped_elements:expr,)*]) => {
        $crate::xml_internal!(@childseq_wrapper [$($seq_elements,)*] [$($wrapped_elements,)* $crate::value::XmlChild::from($first_seq_element)])
    };
    (@childseq_wrapper [] [$($wrapped_elements:expr,)*]) => {
        $crate::value::XmlSeq::from_vec(vec![$($wrapped_elements)*])
    };
    // @seq
    // $unwrapped_if_single = true/false
    // $element_type = @child or @element
    // [$($seq_elements:expr),*] = [$seq_element, ...]
    // $($rest:tt)* = rest of the input

    // Basic types (comments, cdata, pi)
    (@seq $unwrapped_if_single:tt $element_type:tt [$($seq_elements:expr),*] <!--$comment:literal--> $($rest:tt)*) => {
        $crate::xml_internal!(@seq $unwrapped_if_single $element_type [$($seq_elements,)* $crate::value::XmlComment::new($comment.as_bytes())] $($rest)*)
    };
    (@seq $unwrapped_if_single:tt $element_type:tt [$($seq_elements:expr),*] <![CDATA[$cdata:literal]]> $($rest:tt)*) => {
        $crate::xml_internal!(@seq $unwrapped_if_single $element_type [$($seq_elements,)* $crate::value::XmlCData::new($cdata.as_bytes())] $($rest)*)
    };
    (@seq $unwrapped_if_single:tt $element_type:tt [$($seq_elements:expr),*] <?$target:literal $content:literal?> $($rest:tt)*) => {
        $crate::xml_internal!(@seq $unwrapped_if_single $element_type [$($seq_elements,)* $crate::value::XmlProcessingInstruction::new($target.as_bytes(), $content.as_bytes())] $($rest)*)
    };

    // Elements
    // Element adding attribute with namespace
    (@seqelem $unwrapped_if_single:tt $element_type:tt [$($seq_elements:expr),*] $element_name:literal {$element_namespace:expr} [$($attributes:expr),*] $attribute_name:literal:$attribute_namespace:literal = $attribute_value:literal $($rest:tt)*) => {
        $crate::xml_internal!(@seqelem $unwrapped_if_single $element_type [$($seq_elements),*] $element_name {$element_namespace} [$($attributes,)* $crate::value::XmlAttribute::new(
            $crate::ExpandedNameBuf::new(<$crate::LocalNameBuf as std::str::FromStr>::from_str($attribute_name).unwrap(), Some(<$crate::XmlNamespaceBuf as std::str::FromStr>::from_str($attribute_namespace).unwrap())),
            $attribute_value
        )] $($rest)*)
    };
    // Element adding attribute without namespace
    (@seqelem $unwrapped_if_single:tt $element_type:tt [$($seq_elements:expr),*] $element_name:literal {$element_namespace:expr} [$($attributes:expr),*] $attribute_name:literal = $attribute_value:literal $($rest:tt)*) => {
        $crate::xml_internal!(@seqelem $unwrapped_if_single $element_type [$($seq_elements),*] $element_name {$element_namespace} [$($attributes,)* $crate::value::XmlAttribute::new(
            $crate::ExpandedNameBuf::new(<$crate::LocalNameBuf as std::str::FromStr>::from_str($attribute_name).unwrap(), $element_namespace),
            $attribute_value
        )] $($rest)*)
    };
    // Element end without children
    (@seqelem $unwrapped_if_single:tt $element_type:tt [$($seq_elements:expr),*] $element_name:literal {$element_namespace:expr} [$($attributes:expr),*] /> $($rest:tt)*) => {
        $crate::xml_internal!(@seq $unwrapped_if_single $element_type [$($seq_elements,)* $crate::value::XmlElement::new(
            $crate::ExpandedNameBuf::new(<$crate::LocalNameBuf as std::str::FromStr>::from_str($element_name).unwrap(), $element_namespace),
        ).with_attributes::<$crate::value::XmlAttribute, _>(vec![$($attributes),*])] $($rest)*)
    };
    // Element end with children
    (@seqelem $unwrapped_if_single:tt $element_type:tt [$($seq_elements:expr),*] $element_name:literal {$element_namespace:expr} [$($attributes:expr),*] >[ $($children:tt)* ]</$name2:literal> $($rest:tt)*) => {
        $crate::xml_internal!(@seq $unwrapped_if_single $element_type [$($seq_elements,)* {
            assert_eq!($element_name, $name2, "Starting and ending element names must match");
            $crate::value::XmlElement::new(
                $crate::ExpandedNameBuf::new(<$crate::LocalNameBuf as std::str::FromStr>::from_str($element_name).unwrap(), $element_namespace),
            ).with_attributes::<$crate::value::XmlAttribute, _>(vec![$($attributes),*])
            .with_children::<$crate::value::XmlChild, _>($crate::xml_internal!(@seq false "child" [] $($children)*))
        }] $($rest)*)
    };

    // Element start
    //With namespace
    (@seq $unwrapped_if_single:tt $element_type:tt [$($seq_elements:expr),*] <$element_name:literal : $element_namespace:literal $($rest:tt)*) => {
        $crate::xml_internal!(@seqelem $unwrapped_if_single $element_type [$($seq_elements),*] $element_name {Some(<$crate::XmlNamespaceBuf as std::str::FromStr>::from_str($element_namespace).unwrap())} [] $($rest)*)
    };
    //Without namespace
    (@seq $unwrapped_if_single:tt $element_type:tt [$($seq_elements:expr),*] <$element_name:literal $($rest:tt)*) => {
        $crate::xml_internal!(@seqelem $unwrapped_if_single $element_type [$($seq_elements),*] $element_name {None} [] $($rest)*)
    };

    // Text
    (@seq $unwrapped_if_single:tt $element_type:tt [$($seq_elements:expr),*] $text:literal $($rest:tt)*) => {
        $crate::xml_internal!(@seq $unwrapped_if_single $element_type [$($seq_elements,)* $crate::value::XmlText::new($text)] $($rest)*)
    };

    // Sequence ends
    // Ends sequence if single element
    (@seq true $element_type:tt [$seq_element:expr]) => {
        $seq_element
    };
    (@seq $unwrapped_if_single:tt "child" [$($seq_elements:expr),*]) => {
        <$crate::value::XmlSeq<$crate::value::XmlChild> as FromIterator<$crate::value::XmlChild>>::from_iter([$($crate::value::XmlChild::from($seq_elements)),*])
    };
    (@seq $unwrapped_if_single:tt "value" [$($seq_elements:expr),*]) => {
        <$crate::value::XmlSeq<$crate::value::XmlValue> as FromIterator<$crate::value::XmlValue>>::from_iter([$($crate::value::XmlValue::from($seq_elements)),*])
    };

    // Main entry point for the xml! macro.
    (<!--$comment:literal--> $($rest:tt)*) => {
        $crate::xml_internal!(@seq true "value" [] <!--$comment--> $($rest)*)
    };
    (<?$target:literal $content:literal?> $($rest:tt)*) => {
        $crate::xml_internal!(@seq true "value" [] <?$target $content?> $($rest)*)
    };
    (<![CDATA[$cdata:literal]]> $($rest:tt)*) => {
        $crate::xml_internal!(@seq true "value" [] <![CDATA[$cdata]]> $($rest)*)
    };
    (<$element_name:literal : $namespace:literal $($rest:tt)*) => {
        $crate::xml_internal!(@seq true "value" [] <$element_name : $namespace $($rest)*)
    };
    (<$element_name:literal $($rest:tt)*) => {
        $crate::xml_internal!(@seq true "value" [] <$element_name $($rest)*)
    };
    ($text:literal $($rest:tt)*) => {
        $crate::xml_internal!(@seq true "value" [] $text $($rest)*)
    };
}