xml5ever 0.3.0

// Copyright 2015 The xml5ever Project Developers. See the
// COPYRIGHT file at the top-level directory of this distribution.
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.

use std::io::{self, Write};
use std::default::Default;

use tokenizer::{QName, Prefix, Namespace, LocalName};
use tree_builder::NamespaceMap;
use tree_builder;

#[derive(Copy, Clone)]
/// Struct for setting serializer options.
pub struct SerializeOpts {
    /// Serialize the root node? Default: ChildrenOnly
    pub traversal_scope: TraversalScope,
}

#[derive(Copy, Clone, PartialEq)]
/// Enum describing whether or not to serialize the root node.
pub enum TraversalScope {
    /// Serialize only children.
    ChildrenOnly,
    /// Serialize current node and children.
    IncludeNode,
}

impl Default for SerializeOpts {
    fn default() -> SerializeOpts {
        SerializeOpts {
            traversal_scope: TraversalScope::ChildrenOnly
        }
    }
}

/// Trait that must be implemented by Sink in order to for
/// that TreeSink to be serializaled.
pub trait Serializable {
    /// Method for serializing node into text.
    fn serialize<'wr, Wr: Write>(&self, serializer: &mut Serializer<'wr, Wr>,
                                    traversal_scope: TraversalScope) -> io::Result<()>;
}

/// Method for serializing generic node to a given writer.
pub fn serialize<Wr, T> (writer: &mut Wr, node: &T, opts: SerializeOpts)
                        -> io::Result<()>
    where Wr: Write, T: Serializable {

    let mut ser = Serializer::new(writer, opts);
    node.serialize(&mut ser, opts.traversal_scope)
}

/// Struct used for serializing nodes into a text that other XML
/// parses can read.
///
/// Serializer contains a set of functions (start_elem, end_elem...)
/// that make parsing nodes easier.
pub struct Serializer<'wr, Wr:'wr> {
    writer: &'wr mut Wr,
    opts: SerializeOpts,
    namespace_stack: NamespaceMapStack,
}

#[derive(Debug)]
struct NamespaceMapStack(Vec<NamespaceMap>);

impl NamespaceMapStack {
    fn new() -> NamespaceMapStack {
        NamespaceMapStack(vec![])
    }

    fn push(&mut self, namespace: NamespaceMap) {
        self.0.push(namespace);
    }

    fn pop(&mut self) {
        self.0.pop();
    }

}

/// Type representing a single attribute.
/// Contains qualified name and value to attribute respectivelly.
pub type AttrRef<'a> = (&'a QName, &'a str);



/// Writes given text into the Serializer, escaping it,
/// depending on where the text is written inside the tag or attribute value.
///
/// For example
///```
///    <tag>'&-quotes'</tag>   becomes      <tag>'&amp;-quotes'</tag>
///    <tag = "'&-quotes'">    becomes      <tag = "&apos;&amp;-quotes&apos;"
///```
fn write_to_buf_escaped(writer: &mut Write, text: &str, attr_mode: bool) -> io::Result<()> {
    for c in text.chars() {
        try!(match c {
            '&' => writer.write_all(b"&amp;"),
            '\'' if attr_mode => writer.write_all(b"&apos;"),
            '"' if attr_mode => writer.write_all(b"&quot;"),
            '<' if !attr_mode => writer.write_all(b"&lt;"),
            '>' if !attr_mode => writer.write_all(b"&gt;"),
            c => writer.write_fmt(format_args!("{}", c)),
        });
    }
    Ok(())
}

#[inline]
fn write_qual_name(writer: &mut Write, name: &QName) -> io::Result<()> {
    if name.prefix != namespace_prefix!("") {
        try!(writer.write_all(&*name.prefix.as_bytes()));
        try!(writer.write_all(b":"));
        try!(writer.write_all(&*name.local.as_bytes()));
    } else {
        try!(writer.write_all(&*name.local.as_bytes()));
    }

    Ok(())
}

impl<'wr, Wr:Write> Serializer<'wr,Wr> {
    /// Creates a new Serializier from a writer and given serialization options.
    pub fn new(writer: &'wr mut Wr, opts: SerializeOpts) -> Serializer<'wr, Wr> {
        Serializer {
            writer: writer,
            opts: opts,
            namespace_stack: NamespaceMapStack::new(),
        }
    }

    #[inline(always)]
    fn qual_name(&mut self, name: &QName) -> io::Result<()> {
        self.find_or_insert_ns(name);
        write_qual_name(self.writer, name)
    }

    #[inline(always)]
    fn qual_attr_name(&mut self, writer: &mut Write, name: &QName) -> io::Result<()> {
        self.find_or_insert_ns(name);
        write_qual_name(writer, name)
    }

    fn find_uri(&self, name: &QName) -> bool {
        let mut found = false;
        for stack in self.namespace_stack.0.iter().rev() {

            if let Some(&Some(ref el)) = stack.get(&name.prefix) {
                found = *el == name.namespace_url;
                break;
            }
        }
        found
    }

    fn find_or_insert_ns(&mut self, name: &QName) {
        if &*name.prefix != "" || &*name.namespace_url != "" {
            if !self.find_uri(name) {

                if let Some(last_ns) = self.namespace_stack.0.last_mut() {
                    last_ns.insert(name);
                }
            }
        }
    }

    /// Serializes given start element into text. Start element contains
    /// qualified name and an attributes iterator.
    pub fn start_elem<'a, AttrIter: Iterator<Item=AttrRef<'a>>>(
        &mut self,
        name: QName,
        attrs: AttrIter) -> io::Result<()> {

        let mut attr = Vec::new();
        self.namespace_stack.push(NamespaceMap::empty());

        try!(self.writer.write_all(b"<"));
        try!(self.qual_name(&name));
        for (name, value) in attrs {
            try!(attr.write_all(b" "));
            try!(self.qual_attr_name(&mut attr, &name));
            try!(attr.write_all(b"=\""));
            try!(write_to_buf_escaped(&mut attr, value, true));
            try!(attr.write_all(b"\""));

        }
        if let Some(current_namespace) = self.namespace_stack.0.last() {
            for (prefix, url_opt) in current_namespace.get_scope_iter() {
                try!(self.writer.write_all(b" xmlns"));
                if prefix != "" {
                    try!(self.writer.write_all(b":"));
                    try!(self.writer.write_all(&*prefix.as_bytes()));
                }

                try!(self.writer.write_all(b"=\""));
                let url = if let &Some(ref a) = url_opt {
                    a.as_bytes()
                } else {
                    b""
                };
                try!(self.writer.write_all(url));
                try!(self.writer.write_all(b"\""));
            }
        }
        try!(self.writer.write_all(&attr));
        try!(self.writer.write_all(b">"));
        Ok(())
    }

    /// Serializes given end element into text.
    pub fn end_elem(&mut self, name: QName) -> io::Result<()> {
        self.namespace_stack.pop();
        try!(self.writer.write_all(b"</"));
        try!(self.qual_name(&name));
        self.writer.write_all(b">")
    }

    /// Serializes comment into text.
    pub fn write_comment(&mut self, text: &str) -> io::Result<()> {
        try!(self.writer.write_all(b"<!--"));
        try!(self.writer.write_all(text.as_bytes()));
        self.writer.write_all(b"-->")
    }

    /// Serializes given doctype
    pub fn write_doctype(&mut self, name: &str) -> io::Result<()> {
        try!(self.writer.write_all(b"<!DOCTYPE "));
        try!(self.writer.write_all(name.as_bytes()));
        self.writer.write_all(b">")
    }

    /// Serializes text for a node or an attributes.
    pub fn write_text(&mut self, text: &str) -> io::Result<()> {
        write_to_buf_escaped(self.writer, text, false)
    }

    /// Serializes given processing instruction.
    pub fn write_processing_instruction(&mut self, target: &str, data: &str) -> io::Result<()> {
        try!(self.writer.write_all(b"<?"));
        try!(self.writer.write_all(target.as_bytes()));
        try!(self.writer.write_all(b" "));
        try!(self.writer.write_all(data.as_bytes()));
        self.writer.write_all(b"?>")
    }

}