xrust 2.1.0

/*! Defines common features of XML documents.
 */

use std::collections::HashMap;
use std::fmt;
use std::fmt::Formatter;

#[derive(Clone, Debug, PartialEq)]
pub struct XMLDecl {
    pub(crate) version: String,
    pub(crate) encoding: Option<String>,
    pub(crate) standalone: Option<String>,
}

impl XMLDecl {
    pub fn new(version: String, encoding: Option<String>, standalone: Option<String>) -> Self {
        XMLDecl {
            version,
            encoding,
            standalone,
        }
    }
    pub fn version(&self) -> String {
        self.version.clone()
    }
    pub fn set_encoding(&mut self, e: String) {
        self.encoding = Some(e)
    }
    pub fn encoding(&self) -> String {
        self.encoding.as_ref().map_or(String::new(), |e| e.clone())
    }
    pub fn set_standalone(&mut self, s: String) {
        self.standalone = Some(s)
    }
    pub fn standalone(&self) -> String {
        self.standalone
            .as_ref()
            .map_or(String::new(), |e| e.clone())
    }
}

impl fmt::Display for XMLDecl {
    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
        let mut result = String::from("<?xml version=\"");
        result.push_str(self.version.as_str());
        result.push('"');
        if let Some(e) = self.encoding.as_ref() {
            result.push_str(" encoding=\"");
            result.push_str(e.as_str());
            result.push('"');
        };
        if let Some(e) = self.standalone.as_ref() {
            result.push_str(" standalone=\"");
            result.push_str(e.as_str());
            result.push('"');
        };
        f.write_str(result.as_str())
    }
}

pub struct XMLDeclBuilder(XMLDecl);

impl Default for XMLDeclBuilder {
    fn default() -> Self {
        Self::new()
    }
}

impl XMLDeclBuilder {
    pub fn new() -> Self {
        XMLDeclBuilder(XMLDecl {
            version: String::new(),
            encoding: None,
            standalone: None,
        })
    }
    pub fn version(mut self, v: String) -> Self {
        self.0.version = v;
        self
    }
    pub fn encoding(mut self, v: String) -> Self {
        self.0.encoding = Some(v);
        self
    }
    pub fn standalone(mut self, v: String) -> Self {
        self.0.standalone = Some(v);
        self
    }
    pub fn build(self) -> XMLDecl {
        self.0
    }
}

/// DTD declarations.
/// Data is not stored in any fashion conformant with any standard and will be adusted to meet
/// the needs of any validators implemented.
///
/// NB. Names of elements and attributes cannot be stored as QName, since in the DTD it is not possible to resolve the Namespace URI.
/// Instead, they are stored here as a (prefix, local-part) pair.
#[derive(Clone, PartialEq, Debug)]
pub struct DTD {
    /// This struct is for internal consumption mainly, it holding the DTD in various incomplete forms
    /// before construction into useful patterns for validation
    pub(crate) elements: HashMap<(Option<String>, String), DTDPattern>,
    pub(crate) attlists: HashMap<
        (Option<String>, String),
        HashMap<(Option<String>, String), (AttType, DefaultDecl, bool)>,
    >, // Boolean for is_editable;
    pub(crate) notations: HashMap<String, DTDDecl>,
    pub(crate) generalentities: HashMap<String, (String, bool)>, // Boolean for is_editable;
    pub(crate) paramentities: HashMap<String, (String, bool)>,   // Boolean for is_editable;
    publicid: Option<String>,
    systemid: Option<String>,
    pub(crate) name: Option<(Option<String>, String)>,
    pub(crate) patterns: HashMap<(Option<String>, String), DTDPattern>,
}

impl DTD {
    pub fn new() -> DTD {
        let default_entities = vec![
            ("amp".to_string(), ("&".to_string(), false)),
            ("gt".to_string(), (">".to_string(), false)),
            ("lt".to_string(), ("<".to_string(), false)),
            ("apos".to_string(), ("'".to_string(), false)),
            ("quot".to_string(), ("\"".to_string(), false)),
        ];
        DTD {
            elements: Default::default(),
            attlists: Default::default(),
            notations: Default::default(),
            generalentities: default_entities.into_iter().collect(),
            paramentities: HashMap::new(),
            publicid: None,
            systemid: None,
            name: None,
            patterns: HashMap::new(),
        }
    }
}

impl Default for DTD {
    fn default() -> Self {
        Self::new()
    }
}

#[derive(Clone, Debug, Eq, PartialEq)]
pub enum DTDDecl {
    Notation((Option<String>, String), String),
    GeneralEntity((Option<String>, String), String),
    ParamEntity((Option<String>, String), String),
}

#[allow(clippy::upper_case_acronyms)]
#[derive(Clone, Debug, Eq, PartialEq)]
pub(crate) enum AttType {
    CDATA,
    ID,
    IDREF,
    IDREFS,
    ENTITY,
    ENTITIES,
    NMTOKEN,
    NMTOKENS,
    NOTATION(Vec<String>),
    ENUMERATION(Vec<String>),
}

#[allow(clippy::upper_case_acronyms)]
#[derive(Clone, Debug, Eq, PartialEq)]
pub(crate) enum DefaultDecl {
    Required,
    Implied,
    FIXED(String),
    Default(String),
}

#[derive(Clone, PartialEq, Debug)]
pub(crate) enum DTDPattern {
    Choice(Box<DTDPattern>, Box<DTDPattern>),
    Interleave(Box<DTDPattern>, Box<DTDPattern>),
    Group(Box<DTDPattern>, Box<DTDPattern>),
    OneOrMore(Box<DTDPattern>),
    After(Box<DTDPattern>, Box<DTDPattern>),
    Empty,
    NotAllowed,
    Text,
    Value(String),
    Attribute((Option<String>, String), Box<DTDPattern>),
    Element((Option<String>, String), Box<DTDPattern>),
    Ref((Option<String>, String)),
    Any,
    /*
       This Enum is never used, but it might see application when properly validating ENTITYs.
    */
    #[allow(dead_code)]
    List(Box<DTDPattern>),
}