Element.swift

import Foundation
import UIKit

/// This enum provides a list of HTML5 standard element names.  The reason why this isn't
/// used as the `name` property of `ElementNode` is that element nodes could theoretically
/// have non-standard names.
///
public struct Element: RawRepresentable, Hashable {
    
    public typealias RawValue = String
    
    public let rawValue: String
    
    /// This can be extended in case new elements need to be defined.
    ///
    public static var blockLevelElements: Set<Element> = Set([.address, .aztecRootNode, .blockquote, .div, .dl, .dd, .dt, .fieldset, .figure, .figcaption, .form, .h1, .h2, .h3, .h4, .h5, .h6, .hr, .li, .noscript, .ol, .p, .pre, .table, .td, .tr, .ul])
    
    /// List of void elements.  These will *not* to have a closing tag and cannot have children.
    ///
    /// Ref. http://w3c.github.io/html/syntax.html#void-elements
    ///
    public static var voidElements: [Element] = [.area, .base, .br, .col, .embed, .hr, .img, .input, .link, .meta, .param, .source, .track, .wbr, .source]
    
    /// This should hardly be anything other than .pre, but has been made customizable anyway.
    ///
    public static var preformattedElements: [Element] = [.pre]

    /// List of block HTML elements that can be merged together when they are sibling to each other
    ///
    public static var mergeableBlockLevelElements = Set<Element>([.blockquote, .div, .figure, .figcaption, .h1, .h2, .h3, .h4, .h5, .h6, .hr, .li, .ol, .ul, .p, .pre])

    /// List of style HTML elements that can be merged together when they are sibling to each other
    public static var mergeableStyleElements = Set<Element>([.i, .em, .b, .strong, .strike, .u, .code, .cite, .a, .sup, .sub, .mark])

    /// List of block level elements that can be merged but only when they have a single children that is also mergeable
    ///
    public static var mergeableBlocklevelElementsSingleChildren =  Set<Element>()

    // MARK: - Initializers
    
    public init?(rawValue: RawValue) {
        self.init(rawValue)
    }
    
    public init(_ rawValue: RawValue) {
        self.rawValue = rawValue.lowercased()
    }
    
    public func isBlockLevel() -> Bool {
        return Element.blockLevelElements.contains(self)
    }
    
    public func isVoid() -> Bool {
        return Element.voidElements.contains(self)
    }
}

extension Element {
    static let aztecRootNode = Element("aztec.htmltag.rootnode")
}

/// Standard HTML 5 elements
///
extension Element {
    public static let a = Element("a")
    public static let area = Element("area")
    public static let address = Element("address")
    public static let b = Element("b")
    public static let base = Element("base")
    public static let br = Element("br")
    public static let blockquote = Element("blockquote")
    public static let cite = Element("cite")
    public static let code = Element("code")
    public static let col = Element("col")
    public static let dd = Element("dd")
    public static let del = Element("del")
    public static let div = Element("div")
    public static let dl = Element("dl")
    public static let dt = Element("dt")
    public static let em = Element("em")
    public static let embed = Element("embed")
    public static let fieldset = Element("fieldset")
    public static let figure = Element("figure")
    public static let figcaption = Element("figcaption")
    public static let form = Element("form")
    public static let meta = Element("meta")
    public static let h1 = Element("h1")
    public static let h2 = Element("h2")
    public static let h3 = Element("h3")
    public static let h4 = Element("h4")
    public static let h5 = Element("h5")
    public static let h6 = Element("h6")
    public static let hr = Element("hr")
    public static let i = Element("i")
    public static let img = Element("img")
    public static let input = Element("input")
    public static let li = Element("li")
    public static let link = Element("link")
    public static let noscript = Element("noscript")
    public static let ol = Element("ol")
    public static let p = Element("p")
    public static let param = Element("param")
    public static let pre = Element("pre")
    public static let s = Element("s")
    public static let source = Element("source")
    public static let span = Element("span")
    public static let strike = Element("strike")
    public static let strong = Element("strong")
    public static let sub = Element("sub")
    public static let sup = Element("sup")
    public static let table = Element("table")
    public static let tbody = Element("tbody")
    public static let td = Element("td")
    public static let tfoot = Element("tfoot")
    public static let th = Element("th")
    public static let thead = Element("thead")
    public static let tr = Element("tr")
    public static let track = Element("track")
    public static let u = Element("u")
    public static let ul = Element("ul")
    public static let video = Element("video")
    public static let wbr = Element("wbr")
    public static let body = Element("body")
    public static let mark = Element("mark")

}

extension Element {
    static func isBlockLevelElement(_ name: String) -> Bool {
        return Element(name).isBlockLevel()
    }

    var equivalentNames: [Element] {
        switch self {
        case .h1: return [self]
        case .strong: return [self, Element.b]
        case .em: return [self, Element.i]
        case .b: return [self, Element.strong]
        case .i: return [self, Element.em]
        case .s: return [self, Element.strike, Element.del]
        case .del: return [self, Element.strike, Element.s]
        case .strike: return [self, Element.del, Element.s]
        default:
            return [self]
        }
    }    
}