1//! Provides an `Element` type, which represents DOM nodes, and a builder to create them with.
2
3use std::io:: Write;
4use std::collections::{btree_map, BTreeMap};
5
6use std::str;
7use std::rc::Rc;
8use std::borrow::Cow;
9
10use error::{Error, Result};
11
12use quick_xml::Reader as EventReader;
13use quick_xml::Writer as EventWriter;
14use quick_xml::events::{Event, BytesStart, BytesEnd, BytesDecl};
15
16use std::io::BufRead;
17
18use std::str::FromStr;
19
20use std::slice;
21
22use convert::IntoAttributeValue;
23use namespace_set::NamespaceSet;
24use node::Node;
25
26/// helper function to escape a `&[u8]` and replace all
27/// xml special characters (<, >, &, ', ") with their corresponding
28/// xml escaped value.
29pub fn escape(raw: &[u8]) -> Cow<[u8]> {
30 let mut escapes: Vec<(usize, &'static [u8])> = Vec::new();
31 let mut bytes = raw.iter();
32 fn to_escape(b: u8) -> bool {
33 match b {
34 b'<' | b'>' | b'\'' | b'&' | b'"' => true,
35 _ => false,
36 }
37 }
38
39 let mut loc = 0;
40 while let Some(i) = bytes.position(|&b| to_escape(b)) {
41 loc += i;
42 match raw[loc] {
43 b'<' => escapes.push((loc, b"<")),
44 b'>' => escapes.push((loc, b">")),
45 b'\'' => escapes.push((loc, b"'")),
46 b'&' => escapes.push((loc, b"&")),
47 b'"' => escapes.push((loc, b""")),
48 _ => unreachable!("Only '<', '>','\', '&' and '\"' are escaped"),
49 }
50 loc += 1;
51 }
52
53 if escapes.is_empty() {
54 Cow::Borrowed(raw)
55 } else {
56 let len = raw.len();
57 let mut v = Vec::with_capacity(len);
58 let mut start = 0;
59 for (i, r) in escapes {
60 v.extend_from_slice(&raw[start..i]);
61 v.extend_from_slice(r);
62 start = i + 1;
63 }
64
65 if start < len {
66 v.extend_from_slice(&raw[start..]);
67 }
68 Cow::Owned(v)
69 }
70}
71
72
73#[derive(Clone, PartialEq, Eq, Debug)]
74/// A struct representing a DOM Element.
75pub struct Element {
76 prefix: Option<String>,
77 name: String,
78 namespaces: Rc<NamespaceSet>,
79 attributes: BTreeMap<String, String>,
80 children: Vec<Node>,
81}
82
83impl<'a> From<&'a Element> for String {
84 fn from(elem: &'a Element) -> String {
85 let mut writer = Vec::new();
86 elem.write_to(&mut writer).unwrap();
87 String::from_utf8(writer).unwrap()
88 }
89}
90
91impl FromStr for Element {
92 type Err = Error;
93
94 fn from_str(s: &str) -> Result<Element> {
95 let mut reader = EventReader::from_str(s);
96 Element::from_reader(&mut reader)
97 }
98}
99
100impl Element {
101 fn new<NS: Into<NamespaceSet>>(name: String, prefix: Option<String>, namespaces: NS, attributes: BTreeMap<String, String>, children: Vec<Node>) -> Element {
102 Element {
103 prefix, name,
104 namespaces: Rc::new(namespaces.into()),
105 attributes,
106 children,
107 }
108 }
109
110 /// Return a builder for an `Element` with the given `name`.
111 ///
112 /// # Examples
113 ///
114 /// ```rust
115 /// use minidom::Element;
116 ///
117 /// let elem = Element::builder("name")
118 /// .ns("namespace")
119 /// .attr("name", "value")
120 /// .append("inner")
121 /// .build();
122 ///
123 /// assert_eq!(elem.name(), "name");
124 /// assert_eq!(elem.ns(), Some("namespace".to_owned()));
125 /// assert_eq!(elem.attr("name"), Some("value"));
126 /// assert_eq!(elem.attr("inexistent"), None);
127 /// assert_eq!(elem.text(), "inner");
128 /// ```
129 pub fn builder<S: AsRef<str>>(name: S) -> ElementBuilder {
130 let (prefix, name) = split_element_name(name).unwrap();
131 ElementBuilder {
132 root: Element::new(name, prefix, None, BTreeMap::new(), Vec::new()),
133 namespaces: Default::default(),
134 }
135 }
136
137 /// Returns a bare minimum `Element` with this name.
138 ///
139 /// # Examples
140 ///
141 /// ```rust
142 /// use minidom::Element;
143 ///
144 /// let bare = Element::bare("name");
145 ///
146 /// assert_eq!(bare.name(), "name");
147 /// assert_eq!(bare.ns(), None);
148 /// assert_eq!(bare.attr("name"), None);
149 /// assert_eq!(bare.text(), "");
150 /// ```
151 pub fn bare<S: Into<String>>(name: S) -> Element {
152 Element {
153 prefix: None,
154 name: name.into(),
155 namespaces: Rc::new(NamespaceSet::default()),
156 attributes: BTreeMap::new(),
157 children: Vec::new(),
158 }
159 }
160
161 /// Returns a reference to the name of this element.
162 pub fn name(&self) -> &str {
163 &self.name
164 }
165
166 /// Returns a reference to the prefix of this element.
167 ///
168 /// # Examples
169 /// ```rust
170 /// use minidom::Element;
171 ///
172 /// let elem = Element::builder("prefix:name")
173 /// .build();
174 ///
175 /// assert_eq!(elem.name(), "name");
176 /// assert_eq!(elem.prefix(), Some("prefix"));
177 /// ```
178 pub fn prefix(&self) -> Option<&str> {
179 self.prefix.as_ref().map(String::as_ref)
180 }
181
182 /// Returns a reference to the namespace of this element, if it has one, else `None`.
183 pub fn ns(&self) -> Option<String> {
184 self.namespaces.get(&self.prefix)
185 }
186
187 /// Returns a reference to the value of the given attribute, if it exists, else `None`.
188 pub fn attr(&self, name: &str) -> Option<&str> {
189 if let Some(value) = self.attributes.get(name) {
190 return Some(value)
191 }
192 None
193 }
194
195 /// Returns an iterator over the attributes of this element.
196 ///
197 /// # Example
198 ///
199 /// ```rust
200 /// use minidom::Element;
201 ///
202 /// let elm: Element = "<elem a=\"b\" />".parse().unwrap();
203 ///
204 /// let mut iter = elm.attrs();
205 ///
206 /// assert_eq!(iter.next().unwrap(), ("a", "b"));
207 /// assert_eq!(iter.next(), None);
208 /// ```
209 pub fn attrs(&self) -> Attrs {
210 Attrs {
211 iter: self.attributes.iter(),
212 }
213 }
214
215 /// Returns an iterator over the attributes of this element, with the value being a mutable
216 /// reference.
217 pub fn attrs_mut(&mut self) -> AttrsMut {
218 AttrsMut {
219 iter: self.attributes.iter_mut(),
220 }
221 }
222
223 /// Modifies the value of an attribute.
224 pub fn set_attr<S: Into<String>, V: IntoAttributeValue>(&mut self, name: S, val: V) {
225 let name = name.into();
226 let val = val.into_attribute_value();
227
228 if let Some(value) = self.attributes.get_mut(&name) {
229 *value = val.expect("removing existing value via set_attr, this is not yet supported (TODO)"); // TODO
230 return;
231 }
232
233 if let Some(val) = val {
234 self.attributes.insert(name, val);
235 }
236 }
237
238 /// Returns whether the element has the given name and namespace.
239 ///
240 /// # Examples
241 ///
242 /// ```rust
243 /// use minidom::Element;
244 ///
245 /// let elem = Element::builder("name").ns("namespace").build();
246 ///
247 /// assert_eq!(elem.is("name", "namespace"), true);
248 /// assert_eq!(elem.is("name", "wrong"), false);
249 /// assert_eq!(elem.is("wrong", "namespace"), false);
250 /// assert_eq!(elem.is("wrong", "wrong"), false);
251 /// ```
252 pub fn is<N: AsRef<str>, NS: AsRef<str>>(&self, name: N, namespace: NS) -> bool {
253 self.name == name.as_ref() &&
254 self.has_ns(namespace)
255 }
256
257 /// Returns whether the element has the given namespace.
258 ///
259 /// # Examples
260 ///
261 /// ```rust
262 /// use minidom::Element;
263 ///
264 /// let elem = Element::builder("name").ns("namespace").build();
265 ///
266 /// assert_eq!(elem.has_ns("namespace"), true);
267 /// assert_eq!(elem.has_ns("wrong"), false);
268 /// ```
269 pub fn has_ns<NS: AsRef<str>>(&self, namespace: NS) -> bool {
270 self.namespaces.has(&self.prefix, namespace)
271 }
272
273 /// Parse a document from an `EventReader`.
274 pub fn from_reader<R: BufRead>(reader: &mut EventReader<R>) -> Result<Element> {
275 let mut buf = Vec::new();
276
277 let root: Element = loop {
278 let e = reader.read_event(&mut buf)?;
279 match e {
280 Event::Empty(ref e) | Event::Start(ref e) => {
281 break build_element(reader, e)?;
282 },
283 Event::Eof => {
284 return Err(Error::EndOfDocument);
285 },
286 Event::Text { .. } |
287 Event::End { .. } |
288 Event::Comment { .. } |
289 Event::CData { .. } |
290 Event::Decl { .. } |
291 Event::PI { .. } |
292 Event::DocType { .. } => (), // TODO: may need more errors
293 }
294 };
295
296 let mut stack = vec![root];
297
298 loop {
299 match reader.read_event(&mut buf)? {
300 Event::Empty(ref e) => {
301 let elem = build_element(reader, e)?;
302 // Since there is no Event::End after, directly append it to the current node
303 stack.last_mut().unwrap().append_child(elem);
304 },
305 Event::Start(ref e) => {
306 let elem = build_element(reader, e)?;
307 stack.push(elem);
308 },
309 Event::End(ref e) => {
310 if stack.len() <= 1 {
311 break;
312 }
313 let elem = stack.pop().unwrap();
314 if let Some(to) = stack.last_mut() {
315 // TODO: check whether this is correct, we are comparing &[u8]s, not &strs
316 let elem_name = e.name();
317 let mut split_iter = elem_name.splitn(2, |u| *u == 0x3A);
318 let possible_prefix = split_iter.next().unwrap(); // Can't be empty.
319 match split_iter.next() {
320 Some(name) => {
321 match elem.prefix() {
322 Some(prefix) => {
323 if possible_prefix != prefix.as_bytes() {
324 return Err(Error::InvalidElementClosed);
325 }
326 },
327 None => {
328 return Err(Error::InvalidElementClosed);
329 },
330 }
331 if name != elem.name().as_bytes() {
332 return Err(Error::InvalidElementClosed);
333 }
334 },
335 None => {
336 if elem.prefix().is_some() {
337 return Err(Error::InvalidElementClosed);
338 }
339 if possible_prefix != elem.name().as_bytes() {
340 return Err(Error::InvalidElementClosed);
341 }
342 },
343 }
344 to.append_child(elem);
345 }
346 },
347 Event::Text(s) => {
348 let text = s.unescape_and_decode(reader)?;
349 if text != "" {
350 let current_elem = stack.last_mut().unwrap();
351 current_elem.append_text_node(text);
352 }
353 },
354 Event::CData(s) => {
355 let text = reader.decode(&s).into_owned();
356 if text != "" {
357 let current_elem = stack.last_mut().unwrap();
358 current_elem.append_text_node(text);
359 }
360 },
361 Event::Eof => {
362 break;
363 },
364 Event::Comment(s) => {
365 let comment = reader.decode(&s).into_owned();
366 if comment != "" {
367 let current_elem = stack.last_mut().unwrap();
368 current_elem.append_comment_node(comment);
369 }
370 },
371 Event::Decl { .. } |
372 Event::PI { .. } |
373 Event::DocType { .. } => (),
374 }
375 }
376 Ok(stack.pop().unwrap())
377 }
378
379 /// Output a document to a `Writer`.
380 pub fn write_to<W: Write>(&self, writer: &mut W) -> Result<()> {
381 self.to_writer(&mut EventWriter::new(writer))
382 }
383
384 /// Output the document to quick-xml `Writer`
385 pub fn to_writer<W: Write>(&self, writer: &mut EventWriter<W>) -> Result<()> {
386 writer.write_event(Event::Decl(BytesDecl::new(b"1.0", Some(b"utf-8"), None)))?;
387 self.write_to_inner(writer)
388 }
389
390 /// Like `write_to()` but without the `<?xml?>` prelude
391 pub fn write_to_inner<W: Write>(&self, writer: &mut EventWriter<W>) -> Result<()> {
392 let name = match self.prefix {
393 None => Cow::Borrowed(&self.name),
394 Some(ref prefix) => Cow::Owned(format!("{}:{}", prefix, self.name)),
395 };
396
397 let mut start = BytesStart::borrowed(name.as_bytes(), name.len());
398 for (prefix, ns) in self.namespaces.declared_ns() {
399 match *prefix {
400 None => start.push_attribute(("xmlns", ns.as_ref())),
401 Some(ref prefix) => {
402 let key = format!("xmlns:{}", prefix);
403 start.push_attribute((key.as_bytes(), ns.as_bytes()))
404 },
405 }
406 }
407 for (key, value) in &self.attributes {
408 start.push_attribute((key.as_bytes(), escape(value.as_bytes()).as_ref()));
409 }
410
411 if self.children.is_empty() {
412 writer.write_event(Event::Empty(start))?;
413 return Ok(())
414 }
415
416 writer.write_event(Event::Start(start))?;
417
418 for child in &self.children {
419 child.write_to_inner(writer)?;
420 }
421
422 writer.write_event(Event::End(BytesEnd::borrowed(name.as_bytes())))?;
423 Ok(())
424 }
425
426 /// Returns an iterator over references to every child node of this element.
427 ///
428 /// # Examples
429 ///
430 /// ```rust
431 /// use minidom::Element;
432 ///
433 /// let elem: Element = "<root>a<c1 />b<c2 />c</root>".parse().unwrap();
434 ///
435 /// let mut iter = elem.nodes();
436 ///
437 /// assert_eq!(iter.next().unwrap().as_text().unwrap(), "a");
438 /// assert_eq!(iter.next().unwrap().as_element().unwrap().name(), "c1");
439 /// assert_eq!(iter.next().unwrap().as_text().unwrap(), "b");
440 /// assert_eq!(iter.next().unwrap().as_element().unwrap().name(), "c2");
441 /// assert_eq!(iter.next().unwrap().as_text().unwrap(), "c");
442 /// assert_eq!(iter.next(), None);
443 /// ```
444 #[inline] pub fn nodes(&self) -> Nodes {
445 self.children.iter()
446 }
447
448 /// Returns an iterator over mutable references to every child node of this element.
449 #[inline] pub fn nodes_mut(&mut self) -> NodesMut {
450 self.children.iter_mut()
451 }
452
453 /// Returns an iterator over references to every child element of this element.
454 ///
455 /// # Examples
456 ///
457 /// ```rust
458 /// use minidom::Element;
459 ///
460 /// let elem: Element = "<root>hello<child1 />this<child2 />is<child3 />ignored</root>".parse().unwrap();
461 ///
462 /// let mut iter = elem.children();
463 /// assert_eq!(iter.next().unwrap().name(), "child1");
464 /// assert_eq!(iter.next().unwrap().name(), "child2");
465 /// assert_eq!(iter.next().unwrap().name(), "child3");
466 /// assert_eq!(iter.next(), None);
467 /// ```
468 #[inline] pub fn children(&self) -> Children {
469 Children {
470 iter: self.children.iter(),
471 }
472 }
473
474 /// Returns an iterator over mutable references to every child element of this element.
475 #[inline] pub fn children_mut(&mut self) -> ChildrenMut {
476 ChildrenMut {
477 iter: self.children.iter_mut(),
478 }
479 }
480
481 /// Returns an iterator over references to every text node of this element.
482 ///
483 /// # Examples
484 ///
485 /// ```rust
486 /// use minidom::Element;
487 ///
488 /// let elem: Element = "<root>hello<c /> world!</root>".parse().unwrap();
489 ///
490 /// let mut iter = elem.texts();
491 /// assert_eq!(iter.next().unwrap(), "hello");
492 /// assert_eq!(iter.next().unwrap(), " world!");
493 /// assert_eq!(iter.next(), None);
494 /// ```
495 #[inline] pub fn texts(&self) -> Texts {
496 Texts {
497 iter: self.children.iter(),
498 }
499 }
500
501 /// Returns an iterator over mutable references to every text node of this element.
502 #[inline] pub fn texts_mut(&mut self) -> TextsMut {
503 TextsMut {
504 iter: self.children.iter_mut(),
505 }
506 }
507
508 /// Appends a child node to the `Element`, returning the appended node.
509 ///
510 /// # Examples
511 ///
512 /// ```rust
513 /// use minidom::Element;
514 ///
515 /// let mut elem = Element::bare("root");
516 ///
517 /// assert_eq!(elem.children().count(), 0);
518 ///
519 /// elem.append_child(Element::bare("child"));
520 ///
521 /// {
522 /// let mut iter = elem.children();
523 /// assert_eq!(iter.next().unwrap().name(), "child");
524 /// assert_eq!(iter.next(), None);
525 /// }
526 ///
527 /// let child = elem.append_child(Element::bare("new"));
528 ///
529 /// assert_eq!(child.name(), "new");
530 /// ```
531 pub fn append_child(&mut self, child: Element) -> &mut Element {
532 child.namespaces.set_parent(Rc::clone(&self.namespaces));
533
534 self.children.push(Node::Element(child));
535 if let Node::Element(ref mut cld) = *self.children.last_mut().unwrap() {
536 cld
537 } else {
538 unreachable!()
539 }
540 }
541
542 /// Appends a text node to an `Element`.
543 ///
544 /// # Examples
545 ///
546 /// ```rust
547 /// use minidom::Element;
548 ///
549 /// let mut elem = Element::bare("node");
550 ///
551 /// assert_eq!(elem.text(), "");
552 ///
553 /// elem.append_text_node("text");
554 ///
555 /// assert_eq!(elem.text(), "text");
556 /// ```
557 pub fn append_text_node<S: Into<String>>(&mut self, child: S) {
558 self.children.push(Node::Text(child.into()));
559 }
560
561 /// Appends a comment node to an `Element`.
562 ///
563 /// # Examples
564 ///
565 /// ```rust
566 /// use minidom::Element;
567 ///
568 /// let mut elem = Element::bare("node");
569 ///
570 /// elem.append_comment_node("comment");
571 /// ```
572 pub fn append_comment_node<S: Into<String>>(&mut self, child: S) {
573 self.children.push(Node::Comment(child.into()));
574 }
575
576 /// Appends a node to an `Element`.
577 ///
578 /// # Examples
579 ///
580 /// ```rust
581 /// use minidom::{Element, Node};
582 ///
583 /// let mut elem = Element::bare("node");
584 ///
585 /// elem.append_node(Node::Text("hello".to_owned()));
586 ///
587 /// assert_eq!(elem.text(), "hello");
588 /// ```
589 pub fn append_node(&mut self, node: Node) {
590 self.children.push(node);
591 }
592
593 /// Returns the concatenation of all text nodes in the `Element`.
594 ///
595 /// # Examples
596 ///
597 /// ```rust
598 /// use minidom::Element;
599 ///
600 /// let elem: Element = "<node>hello,<split /> world!</node>".parse().unwrap();
601 ///
602 /// assert_eq!(elem.text(), "hello, world!");
603 /// ```
604 pub fn text(&self) -> String {
605 self.texts().fold(String::new(), |ret, new| ret + new)
606 }
607
608 /// Returns a reference to the first child element with the specific name and namespace, if it
609 /// exists in the direct descendants of this `Element`, else returns `None`.
610 ///
611 /// # Examples
612 ///
613 /// ```rust
614 /// use minidom::Element;
615 ///
616 /// let elem: Element = r#"<node xmlns="ns"><a /><a xmlns="other_ns" /><b /></node>"#.parse().unwrap();
617 ///
618 /// assert!(elem.get_child("a", "ns").unwrap().is("a", "ns"));
619 /// assert!(elem.get_child("a", "other_ns").unwrap().is("a", "other_ns"));
620 /// assert!(elem.get_child("b", "ns").unwrap().is("b", "ns"));
621 /// assert_eq!(elem.get_child("c", "ns"), None);
622 /// assert_eq!(elem.get_child("b", "other_ns"), None);
623 /// assert_eq!(elem.get_child("a", "inexistent_ns"), None);
624 /// ```
625 pub fn get_child<N: AsRef<str>, NS: AsRef<str>>(&self, name: N, namespace: NS) -> Option<&Element> {
626 for fork in &self.children {
627 if let Node::Element(ref e) = *fork {
628 if e.is(name.as_ref(), namespace.as_ref()) {
629 return Some(e);
630 }
631 }
632 }
633 None
634 }
635
636 /// Returns a mutable reference to the first child element with the specific name and namespace,
637 /// if it exists in the direct descendants of this `Element`, else returns `None`.
638 pub fn get_child_mut<N: AsRef<str>, NS: AsRef<str>>(&mut self, name: N, namespace: NS) -> Option<&mut Element> {
639 for fork in &mut self.children {
640 if let Node::Element(ref mut e) = *fork {
641 if e.is(name.as_ref(), namespace.as_ref()) {
642 return Some(e);
643 }
644 }
645 }
646 None
647 }
648
649 /// Returns whether a specific child with this name and namespace exists in the direct
650 /// descendants of the `Element`.
651 ///
652 /// # Examples
653 ///
654 /// ```rust
655 /// use minidom::Element;
656 ///
657 /// let elem: Element = r#"<node xmlns="ns"><a /><a xmlns="other_ns" /><b /></node>"#.parse().unwrap();
658 ///
659 /// assert_eq!(elem.has_child("a", "other_ns"), true);
660 /// assert_eq!(elem.has_child("a", "ns"), true);
661 /// assert_eq!(elem.has_child("a", "inexistent_ns"), false);
662 /// assert_eq!(elem.has_child("b", "ns"), true);
663 /// assert_eq!(elem.has_child("b", "other_ns"), false);
664 /// assert_eq!(elem.has_child("b", "inexistent_ns"), false);
665 /// ```
666 pub fn has_child<N: AsRef<str>, NS: AsRef<str>>(&self, name: N, namespace: NS) -> bool {
667 self.get_child(name, namespace).is_some()
668 }
669
670 /// Removes the first child with this name and namespace, if it exists, and returns an
671 /// `Option<Element>` containing this child if it succeeds.
672 /// Returns `None` if no child matches this name and namespace.
673 ///
674 /// # Examples
675 ///
676 /// ```rust
677 /// use minidom::Element;
678 ///
679 /// let mut elem: Element = r#"<node xmlns="ns"><a /><a xmlns="other_ns" /><b /></node>"#.parse().unwrap();
680 ///
681 /// assert!(elem.remove_child("a", "ns").unwrap().is("a", "ns"));
682 /// assert!(elem.remove_child("a", "ns").is_none());
683 /// assert!(elem.remove_child("inexistent", "inexistent").is_none());
684 /// ```
685 pub fn remove_child<N: AsRef<str>, NS: AsRef<str>>(&mut self, name: N, namespace: NS) -> Option<Element> {
686 let name = name.as_ref();
687 let namespace = namespace.as_ref();
688 let idx = self.children.iter().position(|x| {
689 if let Node::Element(ref elm) = x {
690 elm.is(name, namespace)
691 } else {
692 false
693 }
694 })?;
695 self.children.remove(idx).into_element()
696 }
697}
698
699fn split_element_name<S: AsRef<str>>(s: S) -> Result<(Option<String>, String)> {
700 let name_parts = s.as_ref().split(':').collect::<Vec<&str>>();
701 match name_parts.len() {
702 2 => Ok((Some(name_parts[0].to_owned()), name_parts[1].to_owned())),
703 1 => Ok((None, name_parts[0].to_owned())),
704 _ => Err(Error::InvalidElement),
705 }
706}
707
708fn build_element<R: BufRead>(reader: &EventReader<R>, event: &BytesStart) -> Result<Element> {
709 let mut namespaces = BTreeMap::new();
710 let attributes = event.attributes()
711 .map(|o| {
712 let o = o?;
713 let key = str::from_utf8(o.key)?.to_owned();
714 let value = o.unescape_and_decode_value(reader)?;
715 Ok((key, value))
716 })
717 .filter(|o| {
718 match *o {
719 Ok((ref key, ref value)) if key == "xmlns" => {
720 namespaces.insert(None, value.to_owned());
721 false
722 },
723 Ok((ref key, ref value)) if key.starts_with("xmlns:") => {
724 namespaces.insert(Some(key[6..].to_owned()), value.to_owned());
725 false
726 },
727 _ => true,
728 }
729 })
730 .collect::<Result<BTreeMap<String, String>>>()?;
731
732 let (prefix, name) = split_element_name(str::from_utf8(event.name())?)?;
733 let element = Element::new(name, prefix, namespaces, attributes, Vec::new());
734 Ok(element)
735}
736
737/// An iterator over references to child elements of an `Element`.
738pub struct Children<'a> {
739 iter: slice::Iter<'a, Node>,
740}
741
742impl<'a> Iterator for Children<'a> {
743 type Item = &'a Element;
744
745 fn next(&mut self) -> Option<&'a Element> {
746 for item in &mut self.iter {
747 if let Node::Element(ref child) = *item {
748 return Some(child);
749 }
750 }
751 None
752 }
753}
754
755/// An iterator over mutable references to child elements of an `Element`.
756pub struct ChildrenMut<'a> {
757 iter: slice::IterMut<'a, Node>,
758}
759
760impl<'a> Iterator for ChildrenMut<'a> {
761 type Item = &'a mut Element;
762
763 fn next(&mut self) -> Option<&'a mut Element> {
764 for item in &mut self.iter {
765 if let Node::Element(ref mut child) = *item {
766 return Some(child);
767 }
768 }
769 None
770 }
771}
772
773/// An iterator over references to child text nodes of an `Element`.
774pub struct Texts<'a> {
775 iter: slice::Iter<'a, Node>,
776}
777
778impl<'a> Iterator for Texts<'a> {
779 type Item = &'a str;
780
781 fn next(&mut self) -> Option<&'a str> {
782 for item in &mut self.iter {
783 if let Node::Text(ref child) = *item {
784 return Some(child);
785 }
786 }
787 None
788 }
789}
790
791/// An iterator over mutable references to child text nodes of an `Element`.
792pub struct TextsMut<'a> {
793 iter: slice::IterMut<'a, Node>,
794}
795
796impl<'a> Iterator for TextsMut<'a> {
797 type Item = &'a mut String;
798
799 fn next(&mut self) -> Option<&'a mut String> {
800 for item in &mut self.iter {
801 if let Node::Text(ref mut child) = *item {
802 return Some(child);
803 }
804 }
805 None
806 }
807}
808
809/// An iterator over references to all child nodes of an `Element`.
810pub type Nodes<'a> = slice::Iter<'a, Node>;
811
812/// An iterator over mutable references to all child nodes of an `Element`.
813pub type NodesMut<'a> = slice::IterMut<'a, Node>;
814
815/// An iterator over the attributes of an `Element`.
816pub struct Attrs<'a> {
817 iter: btree_map::Iter<'a, String, String>,
818}
819
820impl<'a> Iterator for Attrs<'a> {
821 type Item = (&'a str, &'a str);
822
823 fn next(&mut self) -> Option<Self::Item> {
824 self.iter.next().map(|(x, y)| (x.as_ref(), y.as_ref()))
825 }
826}
827
828/// An iterator over the attributes of an `Element`, with the values mutable.
829pub struct AttrsMut<'a> {
830 iter: btree_map::IterMut<'a, String, String>,
831}
832
833impl<'a> Iterator for AttrsMut<'a> {
834 type Item = (&'a str, &'a mut String);
835
836 fn next(&mut self) -> Option<Self::Item> {
837 self.iter.next().map(|(x, y)| (x.as_ref(), y))
838 }
839}
840
841/// A builder for `Element`s.
842pub struct ElementBuilder {
843 root: Element,
844 namespaces: BTreeMap<Option<String>, String>,
845}
846
847impl ElementBuilder {
848 /// Sets the namespace.
849 pub fn ns<S: Into<String>>(mut self, namespace: S) -> ElementBuilder {
850 self.namespaces
851 .insert(self.root.prefix.clone(), namespace.into());
852 self
853 }
854
855 /// Sets an attribute.
856 pub fn attr<S: Into<String>, V: IntoAttributeValue>(mut self, name: S, value: V) -> ElementBuilder {
857 self.root.set_attr(name, value);
858 self
859 }
860
861 /// Appends anything implementing `Into<Node>` into the tree.
862 pub fn append<T: Into<Node>>(mut self, node: T) -> ElementBuilder {
863 self.root.append_node(node.into());
864 self
865 }
866
867 /// Appends an iterator of things implementing `Into<Node>` into the tree.
868 pub fn append_all<T: Into<Node>, I: IntoIterator<Item = T>>(mut self, iter: I) -> ElementBuilder {
869 for node in iter {
870 self.root.append_node(node.into());
871 }
872 self
873 }
874
875 /// Builds the `Element`.
876 pub fn build(self) -> Element {
877 let mut element = self.root;
878 // Set namespaces
879 element.namespaces = Rc::new(NamespaceSet::from(self.namespaces));
880 // Propagate namespaces
881 for node in &element.children {
882 if let Node::Element(ref e) = *node {
883 e.namespaces.set_parent(Rc::clone(&element.namespaces));
884 }
885 }
886 element
887 }
888}
889
890#[cfg(test)]
891mod tests {
892 use super::*;
893
894 #[test]
895 fn test_element_new() {
896 use std::iter::FromIterator;
897
898 let elem = Element::new( "name".to_owned()
899 , None
900 , Some("namespace".to_owned())
901 , BTreeMap::from_iter(vec![ ("name".to_string(), "value".to_string()) ].into_iter() )
902 , Vec::new() );
903
904 assert_eq!(elem.name(), "name");
905 assert_eq!(elem.ns(), Some("namespace".to_owned()));
906 assert_eq!(elem.attr("name"), Some("value"));
907 assert_eq!(elem.attr("inexistent"), None);
908 }
909
910 #[test]
911 fn test_from_reader_simple() {
912 let xml = "<foo></foo>";
913 let mut reader = EventReader::from_str(xml);
914 let elem = Element::from_reader(&mut reader);
915
916 let elem2 = Element::builder("foo").build();
917
918 assert_eq!(elem.unwrap(), elem2);
919 }
920
921 #[test]
922 fn test_from_reader_nested() {
923 let xml = "<foo><bar baz='qxx' /></foo>";
924 let mut reader = EventReader::from_str(xml);
925 let elem = Element::from_reader(&mut reader);
926
927 let nested = Element::builder("bar")
928 .attr("baz", "qxx")
929 .build();
930 let elem2 = Element::builder("foo")
931 .append(nested)
932 .build();
933
934 assert_eq!(elem.unwrap(), elem2);
935 }
936
937 #[test]
938 fn test_from_reader_with_prefix() {
939 let xml = "<foo><prefix:bar baz='qxx' /></foo>";
940 let mut reader = EventReader::from_str(xml);
941 let elem = Element::from_reader(&mut reader);
942
943 let nested = Element::builder("prefix:bar")
944 .attr("baz", "qxx")
945 .build();
946 let elem2 = Element::builder("foo")
947 .append(nested)
948 .build();
949
950 assert_eq!(elem.unwrap(), elem2);
951 }
952
953 #[test]
954 fn parses_spectest_xml() { // From: https://gitlab.com/lumi/minidom-rs/issues/8
955 let xml = r#"
956 <rng:grammar xmlns:rng="http://relaxng.org/ns/structure/1.0">
957 <rng:name xmlns:rng="http://relaxng.org/ns/structure/1.0"></rng:name>
958 </rng:grammar>
959 "#;
960 let mut reader = EventReader::from_str(xml);
961 let _ = Element::from_reader(&mut reader).unwrap();
962 }
963
964 #[test]
965 fn does_not_unescape_cdata() {
966 let xml = "<test><![CDATA['>blah<blah>]]></test>";
967 let mut reader = EventReader::from_str(xml);
968 let elem = Element::from_reader(&mut reader).unwrap();
969 assert_eq!(elem.text(), "'>blah<blah>");
970 }
971}