Merge pull request #2473 from millenomi/xmldocument-xmlnode-init

Author: swift-ci

Foundation/XMLDocument.swift

@@ -67,8 +67,8 @@ open class XMLDocument : XMLNode {
         return _CFXMLDocPtr(_xmlNode)
     }
 
-    public init() {
-        NSUnimplemented()
+    public convenience init() {
+        self.init(rootElement: nil)
     }
 
     /*!

Foundation/XMLElement.swift

@@ -237,7 +237,7 @@ open class XMLElement: XMLNode {
         }
 
         set {
-            if var nodes = newValue?.map({ $0._xmlNode }) {
+            if var nodes = newValue?.map({ $0._xmlNode! }) {
                 nodes.withUnsafeMutableBufferPointer({ (bufPtr) in
                     _CFXMLSetNamespaces(_xmlNode, bufPtr.baseAddress, bufPtr.count)
                 })

Foundation/XMLNode.swift

@@ -96,14 +96,20 @@ open class XMLNode: NSObject, NSCopying {
         return copy(with: nil)
     }
 
-    internal let _xmlNode: _CFXMLNodePtr
+    internal let _xmlNode: _CFXMLNodePtr!
     internal var _xmlDocument: XMLDocument?
 
     open func copy(with zone: NSZone? = nil) -> Any {
         let newNode = _CFXMLCopyNode(_xmlNode, true)
         return XMLNode._objectNodeForNode(newNode)
     }
 
+    @available(*, deprecated, message: "On Darwin, this initializer creates nodes that are valid objects but crash your process if used. The same behavior is replicated in swift-corelibs-foundation, but you should not use this initializer on either platform; use one of the class methods or initializers instead to create a specific kind of code.")
+    public convenience override init() {
+        // Match the Darwin behavior.
+        self.init(kind: .invalid)
+    }
+    
     /*!
      @method initWithKind:
      @abstract Invokes @link initWithKind:options: @/link with options set to NSXMLNodeOptionsNone
@@ -138,13 +144,15 @@ open class XMLNode: NSObject, NSCopying {
             _xmlNode = _CFXMLNewNamespace("", "")
 
         default:
-            fatalError("invalid node kind for this initializer")
+            _xmlNode = nil
         }
 
         super.init()
 
-        withOpaqueUnretainedReference {
-            _CFXMLNodeSetPrivateData(_xmlNode, $0)
+        if let node = _xmlNode {
+            withOpaqueUnretainedReference {
+                _CFXMLNodeSetPrivateData(node, $0)
+            }
         }
     }
 
@@ -795,6 +803,8 @@ open class XMLNode: NSObject, NSCopying {
     internal var _childNodes: Set<XMLNode> = []
 
     deinit {
+        guard _xmlNode != nil else { return }
+        
         for node in _childNodes {
             node.detach()
         }
@@ -882,7 +892,7 @@ open class XMLNode: NSObject, NSCopying {
             _CFXMLNodeAddPrevSibling(first, child._xmlNode)
         } else {
             let currChild = self.child(at: index - 1)!._xmlNode
-            _CFXMLNodeAddNextSibling(currChild, child._xmlNode)
+            _CFXMLNodeAddNextSibling(currChild!, child._xmlNode)
         }
     }
 

TestFoundation/TestXMLDocument.swift

@@ -9,41 +9,6 @@
 
 class TestXMLDocument : LoopbackServerTest {
 
-    static var allTests: [(String, (TestXMLDocument) -> () throws -> Void)] {
-        return [
-            ("test_basicCreation", test_basicCreation),
-            ("test_nextPreviousNode", test_nextPreviousNode),
-            // Disabled because of https://bugs.swift.org/browse/SR-10098
-            // ("test_xpath", test_xpath),
-            ("test_elementCreation", test_elementCreation),
-            ("test_elementChildren", test_elementChildren),
-            ("test_stringValue", test_stringValue),
-            ("test_objectValue", test_objectValue),
-            ("test_attributes", test_attributes),
-            ("test_attributesWithNamespace", test_attributesWithNamespace),
-            ("test_comments", test_comments),
-            ("test_processingInstruction", test_processingInstruction),
-            ("test_parseXMLString", test_parseXMLString),
-            ("test_prefixes", test_prefixes),
-            /* ⚠️ */ ("test_validation_success", testExpectedToFail(test_validation_success,
-            /* ⚠️ */     #"<https://bugs.swift.org/browse/SR-10643> Could not build URI for external subset "http://127.0.0.1:-2/DTDs/PropertyList-1.0.dtd""#)),
-            /* ⚠️ */ ("test_validation_failure", testExpectedToFail(test_validation_failure,
-            /* ⚠️ */     "<https://bugs.swift.org/browse/SR-10643> XCTAssert in last catch block fails")),
-            ("test_dtd", test_dtd),
-            ("test_documentWithDTD", test_documentWithDTD),
-            ("test_dtd_attributes", test_dtd_attributes),
-            ("test_documentWithEncodingSetDoesntCrash", test_documentWithEncodingSetDoesntCrash),
-            ("test_nodeFindingWithNamespaces", test_nodeFindingWithNamespaces),
-            ("test_createElement", test_createElement),
-            ("test_addNamespace", test_addNamespace),
-            ("test_removeNamespace", test_removeNamespace),
-            ("test_optionPreserveAll", test_optionPreserveAll),
-            ("test_rootElementRetainsDocument", test_rootElementRetainsDocument),
-            ("test_nodeKinds", test_nodeKinds),
-            ("test_sr10776_documentName", test_sr10776_documentName),
-        ]
-    }
-
     func test_basicCreation() {
         let doc = XMLDocument(rootElement: nil)
         XCTAssert(doc.version == "1.0", "expected 1.0, got \(String(describing: doc.version))")
@@ -649,6 +614,47 @@ class TestXMLDocument : LoopbackServerTest {
         doc.name = "name"
         XCTAssertNil(doc.name) // `name` of XMLDocument is always nil.
     }
+    
+    func test_creatingAnEmptyDocumentAndNode() {
+        _ = XMLDocument()
+        _ = XMLNode()
+    }
+    
+    static var allTests: [(String, (TestXMLDocument) -> () throws -> Void)] {
+        return [
+            ("test_basicCreation", test_basicCreation),
+            ("test_nextPreviousNode", test_nextPreviousNode),
+            // Disabled because of https://bugs.swift.org/browse/SR-10098
+            // ("test_xpath", test_xpath),
+            ("test_elementCreation", test_elementCreation),
+            ("test_elementChildren", test_elementChildren),
+            ("test_stringValue", test_stringValue),
+            ("test_objectValue", test_objectValue),
+            ("test_attributes", test_attributes),
+            ("test_attributesWithNamespace", test_attributesWithNamespace),
+            ("test_comments", test_comments),
+            ("test_processingInstruction", test_processingInstruction),
+            ("test_parseXMLString", test_parseXMLString),
+            ("test_prefixes", test_prefixes),
+            /* ⚠️ */ ("test_validation_success", testExpectedToFail(test_validation_success,
+            /* ⚠️ */     #"<https://bugs.swift.org/browse/SR-10643> Could not build URI for external subset "http://127.0.0.1:-2/DTDs/PropertyList-1.0.dtd""#)),
+            /* ⚠️ */ ("test_validation_failure", testExpectedToFail(test_validation_failure,
+            /* ⚠️ */     "<https://bugs.swift.org/browse/SR-10643> XCTAssert in last catch block fails")),
+            ("test_dtd", test_dtd),
+            ("test_documentWithDTD", test_documentWithDTD),
+            ("test_dtd_attributes", test_dtd_attributes),
+            ("test_documentWithEncodingSetDoesntCrash", test_documentWithEncodingSetDoesntCrash),
+            ("test_nodeFindingWithNamespaces", test_nodeFindingWithNamespaces),
+            ("test_createElement", test_createElement),
+            ("test_addNamespace", test_addNamespace),
+            ("test_removeNamespace", test_removeNamespace),
+            ("test_optionPreserveAll", test_optionPreserveAll),
+            ("test_rootElementRetainsDocument", test_rootElementRetainsDocument),
+            ("test_nodeKinds", test_nodeKinds),
+            ("test_sr10776_documentName", test_sr10776_documentName),
+            ("test_creatingAnEmptyDocumentAndNode", test_creatingAnEmptyDocumentAndNode),
+        ]
+    }
 }
 
 fileprivate extension XMLNode {