Added node types.

oozcitak · oozcitak · commit d8de14769590 · 2019-02-06T14:14:07.000+03:00
diff --git a/src/NodeType.coffee b/src/NodeType.coffee
@@ -0,0 +1,15 @@
+module.exports =
+  Document : 1
+  Declaration : 2
+  DocType : 3
+  Element : 4
+  Raw : 5
+  Text : 6
+  CData : 7
+  Comment : 8
+  ProcessingInstruction : 9
+  AttributeDeclaration : 10
+  ElementDeclaration : 11
+  EntityDeclaration : 12
+  NotationDeclaration : 13
+  Dummy : 14
diff --git a/src/XMLCData.coffee b/src/XMLCData.coffee
@@ -1,4 +1,5 @@
 XMLNode = require './XMLNode'
+NodeType = require './NodeType'
 
 # Represents a  CDATA node
 module.exports = class XMLCData extends XMLNode
@@ -13,6 +14,7 @@ module.exports = class XMLCData extends XMLNode
     if not text?
       throw new Error "Missing CDATA text. " + @debugInfo()
 
+    @type = NodeType.CData
     @text = @stringify.cdata text
 
 
diff --git a/src/XMLComment.coffee b/src/XMLComment.coffee
@@ -1,4 +1,5 @@
 XMLNode = require './XMLNode'
+NodeType = require './NodeType'
 
 # Represents a comment node
 module.exports = class XMLComment extends XMLNode
@@ -13,6 +14,7 @@ module.exports = class XMLComment extends XMLNode
     if not text?
       throw new Error "Missing comment text. " + @debugInfo()
 
+    @type = NodeType.Comment
     @text = @stringify.comment text
 
 
diff --git a/src/XMLDTDAttList.coffee b/src/XMLDTDAttList.coffee
@@ -1,4 +1,5 @@
 XMLNode = require './XMLNode'
+NodeType = require './NodeType'
 
 # Represents an attribute list
 module.exports = class XMLDTDAttList extends XMLNode
@@ -33,6 +34,7 @@ module.exports = class XMLDTDAttList extends XMLNode
       throw new Error "Default value only applies to #FIXED or #DEFAULT. " + @debugInfo(elementName)
 
     @elementName = @stringify.name elementName
+    @type = NodeType.AttributeDeclaration
     @attributeName = @stringify.name attributeName
     @attributeType = @stringify.dtdAttType attributeType
     @defaultValue = @stringify.dtdAttDefault defaultValue
diff --git a/src/XMLDTDElement.coffee b/src/XMLDTDElement.coffee
@@ -1,4 +1,5 @@
 XMLNode = require './XMLNode'
+NodeType = require './NodeType'
 
 # Represents an attribute
 module.exports = class XMLDTDElement extends XMLNode
@@ -20,6 +21,7 @@ module.exports = class XMLDTDElement extends XMLNode
       value = '(' + value.join(',') + ')'
 
     @name = @stringify.name name
+    @type = NodeType.ElementDeclaration
     @value = @stringify.dtdElementValue value
 
 
diff --git a/src/XMLDTDEntity.coffee b/src/XMLDTDEntity.coffee
@@ -1,6 +1,7 @@
 { isObject } = require './Utility'
 
 XMLNode = require './XMLNode'
+NodeType = require './NodeType'
 
 # Represents an entity declaration in the DTD
 module.exports = class XMLDTDEntity extends XMLNode
@@ -26,6 +27,7 @@ module.exports = class XMLDTDEntity extends XMLNode
 
     @pe = !!pe
     @name = @stringify.name name
+    @type = NodeType.EntityDeclaration
 
     if not isObject value
       @value =  @stringify.dtdEntityValue value
diff --git a/src/XMLDTDNotation.coffee b/src/XMLDTDNotation.coffee
@@ -1,4 +1,5 @@
 XMLNode = require './XMLNode'
+NodeType = require './NodeType'
 
 # Represents a NOTATION entry in the DTD
 module.exports = class XMLDTDNotation extends XMLNode
@@ -20,6 +21,7 @@ module.exports = class XMLDTDNotation extends XMLNode
       throw new Error "Public or system identifiers are required for an external entity. " + @debugInfo(name)
 
     @name = @stringify.name name
+    @type = NodeType.NotationDeclaration
     @pubID = @stringify.dtdPubID value.pubID if value.pubID?
     @sysID = @stringify.dtdSysID value.sysID if value.sysID?
 
diff --git a/src/XMLDeclaration.coffee b/src/XMLDeclaration.coffee
@@ -1,6 +1,7 @@
 { isObject } = require './Utility'
 
 XMLNode = require './XMLNode'
+NodeType = require './NodeType'
 
 # Represents the XML declaration
 module.exports = class XMLDeclaration extends XMLNode
@@ -22,6 +23,7 @@ module.exports = class XMLDeclaration extends XMLNode
 
     version = '1.0' if not version
 
+    @type = NodeType.Declaration
     @version = @stringify.xmlVersion version
     @encoding = @stringify.xmlEncoding encoding if encoding?
     @standalone = @stringify.xmlStandalone standalone if standalone?
diff --git a/src/XMLDocType.coffee b/src/XMLDocType.coffee
@@ -1,6 +1,7 @@
 { isObject } = require './Utility'
 
 XMLNode = require './XMLNode'
+NodeType = require './NodeType'
 XMLDTDAttList = require './XMLDTDAttList'
 XMLDTDEntity = require './XMLDTDEntity'
 XMLDTDElement = require './XMLDTDElement'
@@ -20,6 +21,7 @@ module.exports = class XMLDocType extends XMLNode
     super parent
 
     @name = "!DOCTYPE"
+    @type = NodeType.DocType
 
     @documentObject = parent
 
diff --git a/src/XMLDocument.coffee b/src/XMLDocument.coffee
@@ -1,6 +1,7 @@
 { isPlainObject } = require './Utility'
 
 XMLNode = require './XMLNode'
+NodeType = require './NodeType'
 XMLStringifier = require './XMLStringifier'
 XMLStringWriter = require './XMLStringWriter'
 
@@ -29,7 +30,8 @@ module.exports = class XMLDocument extends XMLNode
     super null
 
     @name = "?xml"
-    
+    @type = NodeType.Document
+
     options or= {}
     if not options.writer then options.writer = new XMLStringWriter()
 
diff --git a/src/XMLDocumentCB.coffee b/src/XMLDocumentCB.coffee
@@ -1,5 +1,6 @@
 { isObject, isFunction, isPlainObject, getValue } = require './Utility'
 
+NodeType = require './NodeType'
 XMLElement = require './XMLElement'
 XMLCData = require './XMLCData'
 XMLComment = require './XMLComment'
@@ -50,6 +51,7 @@ module.exports = class XMLDocumentCB
   #          `end`. `onEnd` does not receive any arguments.
   constructor: (options, onData, onEnd) ->
     @name = "?xml"
+    @type = NodeType.Document
     
     options or= {}
 
diff --git a/src/XMLDummy.coffee b/src/XMLDummy.coffee
@@ -1,4 +1,5 @@
 XMLNode = require './XMLNode'
+NodeType = require './NodeType'
 
 # Represents a  raw node
 module.exports = class XMLDummy extends XMLNode
@@ -13,6 +14,7 @@ module.exports = class XMLDummy extends XMLNode
   constructor: (parent) ->
     super parent
 
+    @type = NodeType.Dummy
     @isDummy = true
 
 
diff --git a/src/XMLElement.coffee b/src/XMLElement.coffee
@@ -1,6 +1,7 @@
 { isObject, isFunction, getValue } = require './Utility'
 
 XMLNode = require './XMLNode'
+NodeType = require './NodeType'
 XMLAttribute = require './XMLAttribute'
 
 # Represents an element of the XML document
@@ -19,6 +20,7 @@ module.exports = class XMLElement extends XMLNode
       throw new Error "Missing element name. " + @debugInfo()
 
     @name = @stringify.name name
+    @type = NodeType.Element
     @attributes = {}
 
     @attribute attributes if attributes?
diff --git a/src/XMLProcessingInstruction.coffee b/src/XMLProcessingInstruction.coffee
@@ -1,4 +1,5 @@
 XMLNode = require './XMLNode'
+NodeType = require './NodeType'
 
 # Represents a processing instruction
 module.exports = class XMLProcessingInstruction extends XMLNode
@@ -15,6 +16,7 @@ module.exports = class XMLProcessingInstruction extends XMLNode
     if not target?
       throw new Error "Missing instruction target. " + @debugInfo()
 
+    @type = NodeType.ProcessingInstruction
     @target = @stringify.insTarget target
     @value = @stringify.insValue value if value
 
diff --git a/src/XMLRaw.coffee b/src/XMLRaw.coffee
@@ -1,4 +1,5 @@
 XMLNode = require './XMLNode'
+NodeType = require './NodeType'
 
 # Represents a  raw node
 module.exports = class XMLRaw extends XMLNode
@@ -13,6 +14,7 @@ module.exports = class XMLRaw extends XMLNode
     if not text?
       throw new Error "Missing raw text. " + @debugInfo()
 
+    @type = NodeType.Raw
     @value = @stringify.raw text
 
 
diff --git a/src/XMLText.coffee b/src/XMLText.coffee
@@ -1,4 +1,5 @@
 XMLNode = require './XMLNode'
+NodeType = require './NodeType'
 
 # Represents a text node
 module.exports = class XMLText extends XMLNode
@@ -13,6 +14,7 @@ module.exports = class XMLText extends XMLNode
     if not text?
       throw new Error "Missing element text. " + @debugInfo()
 
+    @type = NodeType.Text
     @value = @stringify.text text
 
 
diff --git a/test/basic/nodetype.coffee b/test/basic/nodetype.coffee
@@ -0,0 +1,42 @@
+NodeType = require '../../src/NodeType'
+
+suite 'Check node type:', ->
+  test 'Document node types', ->
+    obj =
+        root:
+            '@age': 35
+            '#raw': ''
+            '#text': ''
+            '#cdata': ''
+            '#comment': ''
+            '?pi': ''
+
+    doc = xml(obj, { sysID: 'hello.dtd' }).doc()
+    root = doc.root()
+    root.dummy()
+
+    eq(doc.type, NodeType.Document)
+    eq(doc.children[0].type, NodeType.Declaration)
+    eq(doc.children[1].type, NodeType.DocType)
+    eq(root.type, NodeType.Element)
+    eq(root.children[0].type, NodeType.Raw)
+    eq(root.children[1].type, NodeType.Text)
+    eq(root.children[2].type, NodeType.CData)
+    eq(root.children[3].type, NodeType.Comment)
+    eq(root.children[4].type, NodeType.ProcessingInstruction)
+    eq(root.children[5].type, NodeType.Dummy)
+
+  test 'DTD node types', ->
+    dtd = xml('root', { headless: true }).dtd()
+      .att('img', 'height', 'CDATA', '#REQUIRED')
+      .ele('img', 'EMPTY')
+      .ent('ent', 'my val')
+      .pent('ent', 'my val')
+      .not('fs', { sysID: 'http://my.fs.com/reader' })
+
+    eq(dtd.type, NodeType.DocType)
+    eq(dtd.children[0].type, NodeType.AttributeDeclaration)
+    eq(dtd.children[1].type, NodeType.ElementDeclaration)
+    eq(dtd.children[2].type, NodeType.EntityDeclaration)
+    eq(dtd.children[3].type, NodeType.EntityDeclaration)
+    eq(dtd.children[4].type, NodeType.NotationDeclaration)
